Skip to content

Latest commit

 

History

History
28 lines (21 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

28 lines (21 loc) · 1.67 KB
Raw

Contributing to AudioReach Kernel

Hi there! We’re thrilled that you’d like to contribute to this project. Your help is essential for keeping this project great and for making it better.

Branching Strategy

In general, contributors should develop on branches based off of master and pull requests should be made against master.

Submitting a pull request

  1. Please read our code of conduct and license.
  2. Fork and clone the repository.
  3. Create a new branch based on master: git checkout -b <my-branch-name> master.
  4. Make your changes, add tests, and make sure the tests still pass.
  5. Commit your changes using the DCO. You can attest to the DCO by commiting with the -s or --signoff options or manually adding the "Signed-off-by":
  6. Push to your fork and submit a pull request from your branch to master.
  7. Pat yourself on the back and wait for your pull request to be reviewed.

Here are a few things you can do that will increase the likelihood of your pull request to be accepted:

  • Follow the existing style where possible. We try and adhere to pep8.
  • Write tests.
  • Keep your change as focused as possible. If you want to make multiple independent changes, please consider submitting them as separate pull requests.
  • Write a good commit message.
  • It's a good idea to arrange a discussion with other developers to ensure there is consensus on large features, architecture changes, and other core code changes. PR reviews will go much faster when there are no surprises.