Contributing Guidelines
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
We use GitHub to host code, track issues, and feature requests, as well as accept pull requests.
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/added logic, update the documentation.
- Ensure the test suite passes using
make test-buildlocally. - Make sure your code lints.
- Issue that pull request!
Report issues using GitHub's issues
We use GitHub issues to track public bugs and feature requests. Create a new issue by opening a new issue; it's that easy!
We follow the A Simplified Convention for Naming Branches and Commits in Git for branch names and PR titles.
Branch names should follow the next regex: ^(feat|fix|refactor|chore|docs|test|library)\/[a-z0-9._-]+$.
The branch name must start with a feature, bugfix, hotfix, or test prefix followed by / and then a description.
Pull request titles should follow the next regex: ^(feat|fix|refactor|chore|docs|test|library)(\([^ ]*\))?: [a-zA-Z0-9._ ]*$.
The pull request must start with a feat, fix, refactor, chore, docs, test, or library.
Then, optionally, followed by (CATAGORY), where the category must be a single word without spaces.
After that, a : and a short description of the PR.
A Contributor License Agreement (CLA) is a legal document that outlines the terms and conditions under which a contributor submits their work, such as code, documentation, or other materials, to a project.
Before submitting any Pull Request, please take a look at our CLA document, fill it out and send it to [email protected]. After that, you are good to go.
