Thank you for your interest in contributing to our project! This guide will provide you with an overview of the contribution workflow, from opening an issue to creating a pull request (PR), reviewing, and merging the PR.
To gain a better understanding of the project, please read the README. It contains valuable information on how to start making open-source contributions.
Before creating a new issue, please search to check if a similar issue already exists. If you can't find a related issue, you can open a new one using the appropriate issue form.
Feel free to browse through our existing issues to find one that aligns with your interests. You can utilize labels as filters to narrow down your search. For more details, refer to the Labels section. Typically, we don't assign issues to specific individuals. If you identify an issue you'd like to address, you're welcome to open a PR with your proposed fix.
- Fork the repository.
- Install or update dependency such as Node.js. For more information, see README.
- Create a working branch and start with your changes! (eg. feat/newFeature)
- Test your code using prepared test code, you can add additional test code.
- Commit your updates.
Once you've completed your changes, it's time to create a pull request (PR):
- Pull requests for developed changes should be directed towards the
dev
branch. - Don't forget to link PR to issue if you are solving one.
- Once you submit your PR, team member will review your proposal. We may ask questions or request additional information.
- Once the review is complete, the changes will be automatically merged into the
dev
branch.
Congratulations! 🎉🎉 Thank you for contributing to our project! Your efforts are greatly appreciated.