We want to make contributing to Capsule as easy and transparent as possible.
Contributions are welcome, and are accepted via pull requests. Please review these guidelines before submitting any pull requests.
We actively welcome your pull requests.
- Fork the repo and create your branch from
main
. - Create a new branch for your feature.
- If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- Open a pull request detailing your changes.
- Send a coherent commit history, making sure each individual commit in your pull request is meaningful.
- You may need to rebase to avoid merge conflicts.
- Please remember that we follow SemVer.
We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.
By contributing to Capsule, you agree that your contributions will be licensed under the LICENSE.md file.