Thanks for contributing! 😀
The following is a set of guidelines for contributing. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
Note: Contributions should be made via pull requests to the dev branch of the repository.
The following are the guidelines we request you to follow in order to contribute to this project.
The commit messages should follow the following pattern:
feat: Description # if a new feature is added
fix: Description # if a bug is fixed
refactor: Description # if code is refactored
docs: Description # if documentation is added
lint: Description # if a lint issue is fixedupdate: Description # if an update is required for a feature
bug: Description # if there is a bug in a particular feature
suggestion: Description # if you want to suggest a better way to implement a featureThe code should satisfy the following:
- Have meaningful variable names, either in
snake_caseorcamelCase. - Have no
lintissues. - Have meaningful file names, directory names and directory structure.
- Have a scope for easy fixing, refactoring and scaling.
Pull requests should have:
- A concise commit message.
- A description of what was changed/added.
You can contribute to any of the features you want, here's what you need to know:
- How the project works.
- The technology stack used for the project.
- A brief idea about writing documentation.
You can contribute by:
- Reporting Bugs
- Suggesting Enhancements
- Code Contribution
- Pull Requests
Make sure to document the contributions well in the pull request.
It is not compulsory to follow the guidelines mentioned above, but it is strongly recommended.