Contributing Guidelines

Glad to have you here!
This documentation contains a set of guidelines to help you during the contribution process.
Thanks for taking part and showing interest towards the project. Looking forward to your contributions!

Contributing to the Project :

Step 01 : Find or Raise an issue from the issues tab.
Step 02 : Wait for the issue to be assigned to you.
Step 03 : Fork the repository to make a local copy on your profile.
Step 04 : Create a new branch to make your changes to.
Step 05 : Work on the issue assigned and add files to be pushed.
Step 06 : Commit the changes with an appropriate and descriptive message.
Step 07 : Make sure your branch on the local copy is ready to be merged into this project.
Step 08 : Open pull request and kindly wait for review by a maintainer.

You can refer to the following articles on basics of Git and Github :

Also feel free to contact the Project Managers if any help is needed.

When raising an issue for a bug please add sufficient details.
Code snippets, screenshots, etc. will always help us understand the issue better.
For typos you need not create new issues. Make changes and push the pull request right away.

Please discuss your suggestions with a maintainer before starting to work on UI/UX.
Provide enough context for your suggestions and keep changes within the project tech stack.
For the cases of doc-enhancement, please follow a suitable format for the documentation.

Make sure your suggestions are discussed before starting any work.
Feel free to explore ideas but keep them within the scope of basic project idea.
The feature should be functioning and properly integrated with the existing codebase.