Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
Please note that this project is released with a Code of Conduct. By participating in this project you agree to abide by its terms.
Issues are very valuable to this project.
- Ideas are a valuable source of contributions others can make
- Problems show where this project is lacking
- With a question, you show where contributors can improve the user experience
When you create a new issue, you need to choose the respective template and it'll guide you through collecting and providing the information needed.
If you find an issue that addresses the problem you're having, please add your own reproduction information to the existing issue rather than creating a new one. Adding a reaction can also help indicate to our maintainers that a particular problem is affecting more than just the reporter.
PRs are always welcome and can be a quick way to get your fix or improvement slated for the next release.
In general, we follow the "fork-and-pull" Git workflow
- Fork the repository to your own Github account
- Clone the project to your machine
- Create a branch locally with a succinct but descriptive name
- Commit changes to the branch
- Follow any guidelines specific to this repo
- Push changes to your fork
- Open a PR in our repository and follow the PR template so that we can efficiently review the changes.
When opening a pull request, consider the following:
You should be clear about which problem you're trying to solve with your contribution. For example:
Add a link to code of conduct in README.md This doesn't tell anything about why it's being done, unlike
Add a link to code of conduct in README.md because users don't always look in the CONTRIBUTING.md This tells the problem that you have found, and the pull request shows the action you have taken to solve it.
The same principle applies to the commit body.
- It follows the provided template
- There are no spelling mistakes
- It follows the conventional commits specification
Our maintainers look at pull requests on a regular basis, and the process follows some simple steps:
- PR gets a minimum of 2 approvals when reviewing
- After being reviewed, it is tested by our internal QA team
- Applicable to bugfixes and features
- After being approved, it is merged
Note that after feedback has been given we expect responses within two weeks. After two weeks we may close the pull request if it isn't showing any activity.
New releases happen automatically with every commit added to the main branch.
If you want to deep dive and help out with development, then first get the project installed locally. After that is done we suggest you have a look at issues that are labelled "good first issue". These are meant to be a great way to get a smooth start and won’t put you in front of the most complex parts of the system.
By sending us your contributions, you are agreeing that your contribution is made subject to the terms of our Contributor Ownership Statement