Please open a new issue before making any pull request. Every pull request should have a reference to an issue.
-
First, fork this repository.
-
Clone it using
git clone https://github.com/[username]/GitHub-Activity-Checker.git -
It is always recommended to make your changes in a new branch rather than master. So create a new branch using
git branch mybug. -
Checkout into your new branch using
git checkout mybug. -
Hack the code, kill the bug or introduce the new feature you had in mind, do all kinds of awesome stuff.
-
After you are done add your changes using
git add --all -
Commit your changes using git commit and provide a commit message:
git commit -m "<commit message>". -
After you have committed your changes push your changes to your forked repository using
git push origin mybug. -
Finally create a pull request from github.
-
If everything is alright then soon your changes will get merged or else you will be asked to make changes.
There should be only one commit per pull request.
Please try to make sure that your commit message and body follows the guidelines below.
-
Commit message should be of the form :
fixes issue #[issue_number] - what you solved in one line -
After Commit message there should follow a commit body where you can mention what you did in short or in detail.
-
Also keep your master branch always updated.
Please try to follow this format as it will be helpful for maintainers as well as co-developers/contributors to stay aligned.