This documentation contains a set of guidelines to help you during the contribution process. We are happy to welcome you to PARYATNA, have a nice contributing journey.
- Take a look at the Existing Issues or create your own Issues!
- Wait for the Issue to be assigned to you after which you can start working on it.
- Note : Every change in this project should/must have an associated issue.
- Fork this Repository. This will create a local Copy of this Repository on your Github Profile.
$ git clone https://github.com/<your-username>/Paryatana
$ cd Paryatana
- If you have already forked the project, update your copy before working.
$ git remote update
$ git checkout <branch-name>
$ git rebase upstream/<branch-name>
Create a new branch. Use its name to identify the issue your addressing.
$ git checkout -b branch_name
- Work on the issue assigned to you.
- Add all the files/folders needed.
- After you've made changes or made your contribution to the project add changes to the branch you've just created by:
$ git add .
- To commit give a descriptive message for the convenience of reveiwer by:
$ git commit -m "message"
- Now you are ready to your work to the remote repository.
- When your work is ready and complies with the project conventions, upload your changes to your fork:
$ git push -u origin Branch_Name
- Go to your repository in browser and click on compare and pull requests. Then add a title and description to your pull request that explains your contribution.
- I will review your pull request and if it is up to the mark it will be merged.
• Make Your First Pull Request! 🚀
• How NOT to contribute to Open Source on GitHub: Tips For Beginners
• Getting started with Git and GitHub
• What is Open Source and How to start?
• Complete Git and GitHub Tutorial
• How to Fix your first Bug in Open Source
• Basic Git Commands
• Getting started with Open Source
• Learn GitHub from Scratch
• To know more about open source in detail, you can go through this cool website opensource.guide
All the best for your open source journey!✨