First off, thank you for considering contributing to our project! We value all the contributions that help us improve and grow. Here's a guide to how you can contribute effectively and ensure a smooth collaboration.
This project and everyone participating in it are governed by our Code of Conduct. By participating, you are expected to uphold this code. Please read Code of Conduct before contributing.
Before creating bug reports, please check the issue tracker to avoid duplicates. When you are creating a bug report, include as many details as possible. Fill out the provided template, the information it asks for helps us resolve issues faster.
This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality. Fill out the feature request template to get started.
The process described here has several steps:
- Fork the repo on GitHub
- Clone the project to your machine
- Commit changes to your branch
- Push your work back up to your fork
- Submit a Pull Request so that we can review your changes
NOTE: Be sure to merge the latest from "upstream" before making a pull request!
We follow semantic commit messages to streamline our release and changelog generation process. Here's how you can do it:
- Format:
<type>(<scope>): <description> - Types:
feat,fix,docs,style,refactor,perf,test,chore - Example:
feat(login): add remember me checkbox
Read more about our semantic commit guidelines in our README.md.
- Describe your changes in detail
- Reference the issue that your PR addresses
- Follow the coding style of the project
- Write tests for your changes
- Document new code based on the project's documentation standards
Please adhere to the project's language and coding conventions. If you're new to the project, take a look at some of the existing code to get an idea of the coding style.
Thank you for contributing to our project!