Skip to content

Latest commit

 

History

History
117 lines (72 loc) · 3.75 KB

CONTRIBUTING.md

File metadata and controls

117 lines (72 loc) · 3.75 KB
Raw

Contributing

Contributions are welcome, and they are greatly appreciated! Every little helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs to our issue page. If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

Write Documentation

RAPT BLE could always use more documentation, whether as part of the official RAPT BLE docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback our issue page on GitHub. If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome 😊

Get Started!

Ready to contribute? Here's how to set yourself up for local development.

  1. Fork the repo on GitHub.

  2. Clone your fork locally:

    $ git clone [email protected]:your_name_here/rapt-ble.git

  3. Install the project dependencies with Poetry:

    $ poetry install

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you're done making changes, check that your changes pass our tests:

    $ poetry run pytest

  6. Linting is done through pre-commit. Provided you have the tool installed globally, you can run them all as one-off:

    $ pre-commit run -a

    Or better, install the hooks once and have them run automatically each time you commit:

    $ pre-commit install

  7. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "feat(something): your detailed description of your changes"
$ git push origin name-of-your-bugfix-or-feature

    Note: the commit message should follow the conventional commits. We run commitlint on CI to validate it, and if you've installed pre-commit hooks at the previous step, the message will be checked at commit time.

  8. Submit a pull request through the GitHub website or using the GitHub CLI (if you have it installed):

    $ gh pr create --fill

Pull Request Guidelines

We like to have the pull request open as soon as possible, that's a great place to discuss any piece of work, even unfinished. You can use draft pull request if it's still a work in progress. Here are a few guidelines to follow:

  1. Include tests for feature or bug fixes.
  2. Update the documentation for significant features.
  3. Ensure tests are passing on CI.

Tips

To run a subset of tests:

$ pytest tests

Making a new release

The deployment should be automated and can be triggered from the Semantic Release workflow in GitHub. The next version will be based on the commit logs. This is done by python-semantic-release via a GitHub action.