This documentation contains a set of guidelines to help you during the contribution process of this project. I'm happy to welcome all the contributions from anyone willing to add new scripts to this repository. Thank you for helping out and remember, No contribution is too small.
Please make sure you follow this guidelines so your code can be merged as quickly as possible
When contributing to this repository, if you notice any bugs, issues or you have an idea/feature you would like to add to this project, please raise an issue first. Templates for issues have been created, you can choose here.
Please if you have been assigned an issue, make sure you create a new branch and work from there. Do not! 🛑 push from the main branch so your code can be merged.
When making changes, fixing an issue or adding features to this project, please only add code that is related to the issue or feature you have been assigned to. For E.g If your feature is to add a button, your pull request should contain code that adds the button only.
-
Don't make two different changes in one pull request. If you see another issue aside from the one you are working on. Raise a different PR for it. 🙏🏽
-
And remember, the smaller the change, the faster for it to be reviewed and merged. 🙂
-
Do not delete or modify someone else's code in this repository, unless stated otherwise.
-
Give a meaningful name to whatever file or folder you are adding.
Write your commit message in the imperative: "Fix bug" and not "Fixed bug" or "Fixes bug." This convention matches up with commit messages generated by commands like git merge and git revert.
- Keep your commits short but descriptive.
- Do not end a commit message with a period
.
If you are completely new to open source contribution and everything written here sounds confusing to you, I highly recommend you check out these resources. They will get you up to speed and you can come back to contribute your awesome ideas.
- How to contribute to open source - Complete Guide by Eddie Jaoude.
- How NOT to contribute to open source on GitHub - (5 tips) by Eddie Jaoude.
- How to keep your GitHub Fork in-sync and up to date by Eddie Jaoude
You can refer to the following articles on basics of Git and Github and also contact me, 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
Tips from me 😇
It always takes time to understand and learn. So, do not worry at all. I know you have got this!
