Skip to main content

Contributing

Here we will explain how to contribute to Bucketeer in a few simple steps.

Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License Agreement (CLA) described at bucketeer-io/bucketeer/master/CLA.md.
You (or your employer) retain the copyright to your contribution; this gives us permission to use and redistribute your contributions as part of the project.

You generally only need to sign a CLA once, so if you've already signed one, you probably don't need to do it again.

If you haven't signed it yet, bucketeer-bot will guide you through signing the CLA when you send the first pull request to bucketeer-io/bucketeer repository.

Creating an issue

Please create an issue in the bucketeer-io/bucketeer repository if you find a problem.

Creating a pull request

To find good issues for your first pull request, you can use our help wanted issues or our good first issues as a reference.

info

Please do not force push to your PR branch after asking for a review. It will force us to review the whole PR again because we don't know what has changed.

Commit message format

We are following the Conventional Commits 1.0.0 message rules.
This format leads to easier-to-read commit history and enables us to generate changelogs and follow semantic versioning.

tip

The commit message is used for our release changelog. Please write a message that is easier to understand from the user's point of view.

Types

Must be one of the following:

  • build: Changes that affect the build system or external library dependencies
  • chore: Other changes that don't modify src or test files
  • ci: Changes to the CI configuration files and scripts
  • docs: Documentation only changes
  • feat: A new or a feature update
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • revert: Reverts a previous commit
  • test: Adding missing or correcting existing tests
info

For BREAKING CHANGES commits, you must append a ! after the type, which introduces a breaking API change (correlating with MAJOR in Semantic Versioning).
E.g. feat!: new API interface 2.0

Subject

The subject contains the description of the change:

  • Use the imperative, present tense: "change" not "changed" nor "changes"
  • Don't capitalize the first letter
  • No dot (.) at the end

Example

feat: add webhook feature
^--^ ^-----------------^
| |
| +-> Subject in present tense. Not capitalized.
|
+-------> Type: build|chore|ci|docs|feat|fix|perf|refactor|revert|test

Code reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.