This documentation contains a set of guidelines to help you during the contribution process. We are happy to welcome all the contributions from anyone willing to improve/add new features to this project. Thank you for helping out and remember, no contribution is too small.
You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck:
- Forking a Repo
- Cloning a Repo
- How to create a Pull Request
- Getting started with Git and GitHub
- Learn GitHub from Scratch
- Go to the project's issues.
- Check existing issues before creating a similar one.
- Give proper description for the issues.
- Don't spam to get the assignment of the issue.
- Wait until someone is looking into it !.
- Start working on issue only after you got assigned that issue 🚀.
- Engage in discussion if you have any doubts related to the issue.
If you'd like to contribute to this project, follow the steps
- Branch Out: Create a new branch with a meaningful name. Branching allows you to work on a separate line of development without affecting the main codebase.
$ git checkout -b <your_branch_name>-
✍️Make Changes: Work your magic on the codebase. Modify existing files, add new ones, or remove unnecessary ones as needed.
-
📁Track Changes: After making your modifications, add the changed files to the staging area.
$ git add . -
🚚Commit: Commit your changes with a descriptive message that summarizes the changes you've made.
$ git commit -m "<commit message>" -
🚀Push Changes: Push your committed changes to your forked repository on GitHub. This will allow you to create a pull request from your branch.
$ git push -u origin <your_branch_name>
-
🌐Create Pull Request: Head to GitHub, navigate to your forked repository, and initiate a pull request by clicking "Compare & pull request".
- Ensure that you have self reviewed your code 😀
- Make sure you have added the proper description for the functionality of the code
- Comment code, particularly in hard-to-understand areas.
- Add screenshot it help in review.
- Submit your PR by giving the necesarry information and hang tight we will review it really soon 🚀
Be Respectful: Maintain a respectful and professional tone in all communications related to the issue. We encourage collaboration and constructive feedback to drive improvements in the project.