Skip to content

CONTRIBUTING.adoc

Latest commit

 

History

History
85 lines (51 loc) · 3.34 KB

CONTRIBUTING.adoc

File metadata and controls

85 lines (51 loc) · 3.34 KB
Raw

UnifiedDB Contribution Guide

Thank you for your interest in contributing to UnifiedDB! We welcome all contributions that meet our code of conduct.

Ways to contribute

Bug Reports

Bug reports should be filed as a GitHub Issue using the Bug report template.

Feature Requests

Feature requests should be filed as a GitHub Issue using the Feature request template.

Bug Fixes

Bug fixes should be submitted as a Pull Request.

There should be a corresponding GitHub Issue for the PR. Ensure the two are linked by adding "closes #<issue number>" in the PR description.

New data, tools, and features

New data (for example, adding an extension), tools, or features should be submitted as a Pull Request.

There should be a corresponding GitHub Issue for the PR. Ensure the two are linked by adding "closes #<issue number>" in the PR description.

Submitting a Pull Request

All patches must meet the UnifiedDB code standards. This includes:

  • Pass regression tests

    • run locally as ./bin/regress --all…​though this will take a while to run sequentially. These will also run in GitHub automatically.

  • Use appropriate commit messages

  • Go through code review as a Pull Request

Regression tests

All contributions must pass the full suite of regression tests. Tests are documented more in Continuous Integration.

Commit messages

We use a squash merge policy for PRs. The commit message that appears in main is the PR title and description, and reviewers will ask that those are brief but descriptive. We also strive to follow Conventional Commits v1.0.0, though that is not enforced.

Linked Issues and PRs

When a commit will close a GitHub Issue, it should be noted in the PR description.

Fixes #<issue number>
Closes #<issue number>

Code review

All Pull Requests must go through the code review process.

All Pull Requests require approval by at least one maintainer.

Finding tasks

If you are looking to contribute but are unsure what to do, browse through the issues. We try to keep them tagged by area and mark easier tasks with "good first issue".

Legal

All contributions to UnifiedDB are by default made under the BSD-3-Clause-Clear license. Copyrights are held by the specific contributors, and are not tracked by the UnifiedDB project other than what can be gleaned through git history.

Under special circumstances code may be added under a different license. For example, code from an existing project may be integrated after careful deliberation. Any contributions under a different license will receive extra review. When any contribution is made under a different license, it must be tracked using a Reuse-compatible identifier.

To keep UnifiedDB open to both private and commercial interests, contributions under a copyleft license will never be accepted.

Maintainers

The current maintainers for UnifiedDB are:

  • Derek Hower (@dhower-qc)

  • Paul Clarke (@ThinkOpenly)