Contributing
We really like contributions in several forms. See the contribution guidelines below -
👍🎉 First off, thanks for taking the time to contribute! 🎉👍
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix in one of the codes
- Proposing new questions and code
Steps to follow 📜
1. Sync it ♻️
Always keep your local copy of repository updated with the original repository. Before making any changes and/or in an appropriate interval, run the following commands carefully to update your local repository.
# Fetch all remote repositories and delete any deleted remote branches
git fetch --all --prune
# Switch to `master` branch
git checkout master
# Reset local `master` branch to match `upstream` repository's `master` branch
git reset --hard upstream/master
# Push changes to your forked `pennamechooser` repo
git push origin master
5. Ready Steady Go... 🐢 🐇
Once you have completed these steps, you are ready to start contributing by checking our Help Wanted
Issues and creating Pull requests
6. Create a new branch ‼️
Whenever you are going to make contribution, please create a separate branch using command and keep your master
branch clean (i.e. synced with remote branch).
# It will create a new branch with name Branch_Name and will switch to that branch.
git checkout -b Branch_Name
Create a separate branch for contribution and try to use same name of branch as of folder.
To switch to desired branch
# To switch from one folder to other
git checkout Branch_Name
To add the changes to the branch. Use
# To add all files to branch Branch_Name
git add .
Type in a message relevant for the code reviewer using
# This message gets associated with all files you have changed
git commit -s -m 'relevant message'
Now, Push your awesome work to your remote repository using
# To push your work to your remote repository
git push -u origin Branch_Name
Finally, 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 precious effort.
Sit and relax till we review your PR, you've made your contribution to our project.
🎉 🎊 😃 Happy Contributing 😃 🎊 🎉