Steps to Contribute
Browse to https://github.com/hyperledger/education
Click the fork button
Clone the repository to your machine using:
git clone https://github.com/username/education, replacing
usernamewith your Github username.
Change to the
Verify that git is configured properly. Specifically, make sure that your name and email in your local machine settings match the name and email associated with your Github profile.
git config user.email git config user.name
If the values do not match your Github profile, you can set them with the following, replacing
Mona Lisawith the values that match your Github profile. NOTE: This will only change the configuration for the
educationrepository. If you want to change it for all repositories, use
git config --globalinstead.
git config user.email "email@example.com" git config user.name "Mona Lisa"
Create a branch for you work using
git checkout -b branch-name, replacing
branch-namewith a name to reflect the work that you are doing. For example, if you are working on issue #45, you might name your branch
Make your modifications using your favorite text editor.
Verify your changes are what you want. You can use
git diffto see all the changes that you have made.
If the changes are what you want, then commit the source code using the following.
IT IS IMPORTANT TO INCLUDE THE
-sOPTION TO SIGN YOUR COMMIT.
git add . git commit -s -m "insert message reflecting what you changed"
Optional: If you performed multiple commits on your local branch, you can squash these commits using
git rebase -i HEAD~<# of commits>. For example, to squash four commits into one, do the following:
git rebase -i HEAD~4
In the text editor that comes up, keep the word
pickfor the first commit and replace the words
squashnext to all other commits. Save and close the editor, and git will combine the "squash"'ed commits with the one before it. Git will then give you the opportunity to change your commit message to something like, "Issue #100: Fixed retweet bug." Make sure that your commit message also contains the DCO sign-off line.
Important: If you've already pushed commits to GitHub, and then squash them locally, you will have to force the push to your branch.
git push origin branch-name --force
Helpful hint: Before doing a push, you can always edit your last commit message, before pushing, by using:
git commit --amend -s
-soption will add the necessary line for the DCO sign-off.
Push your changes, replacing
branch-namewith the branch name that you created above.
git push origin branch-name
Create a new pull request by visiting
usernamewith your Github username. Click the "New Pull Request" button.
Verify that the pull request contains your commits and that all commits are signed off prior to creating the pull request.