We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer
We use Github Flow, so all code changes happen through Pull Requests
Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:
- Fork the repo and create your branch from
main. - 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.
- Issue that pull request!
We encourage the use of semantic commit messages for better understanding of what is being done in each commit.
We use a changelog based on Keep a Changelog. We add new entries to it in the commit that makes the changes.
Our versioning follows Semantic Versioning.
For more best practices details, read stone-best-practices.
Report bugs using Github's issues
All of our issues have a template with tips for describing the problem. Try to follow the proposed structure, this helps the reviewer a lot.
By contributing, you agree that your contributions will be licensed under its MIT license.