diff --git a/README.md b/README.md index d5e505d..df47722 100644 --- a/README.md +++ b/README.md @@ -79,9 +79,11 @@ make html ## 5. Developer guide -### GitHub refresher for those who would like to contribute + +### GitHub refresher #### Push new changes -```bash + +``` git status git pull git add -A . @@ -89,6 +91,35 @@ git commit -m "Change a specific functionality" git push -u origin main ``` +#### Making a pull request +``` +git checkout main +git pull + +# Before you begin making changes, create a new branch +git checkout -b new-feature-branch +git add -A +git commit -m "Detailed commit message describing the changes" +git push -u origin new-feature-branch + +# Visit github.com to add description, submit, merge the pull request + +# Once finished on github.com, return to local +git checkout main +git pull + +# Delete the remote branch +git branch -d new-feature-branch +``` + +#### Handle merge conflict + +``` +git stash push --include-untracked +git stash drop +git pull +``` + ### Copyright