Contributor Guidelines

Jump to bottom Edit New page

Luke Schoen edited this page Aug 13, 2017 · 1 revision

Table of Contents

Chapter 1 - Developers
Chapter 2 - Non-Developers

Chapter 1 - Developers

GitHub and Git

Create GitHub account
Fork a Peerism repository
Show Git commands available git --help
Clone the fork on your local computer git clone <insert_url> and change into the directory
Add the Peerism repository as an upstream to synchronise with the fork git remote add upstream <insert_url_to_peerism_repository>
Show the remote branches available git remote -v
Pull latest changes from master branch of remote upstream Peerism repository into local master branch: git pull upstream master
Create a Branch git checkout -b <branch_name>
Show Difference after making code changes git diff
Add Edits ready to commit git add --all .
Commit to current branch `git commit -m "<insert_message>"
Show Git Status git status
Push changes to your remote fork git push origin <insert_branch_name>
Create GitHub Pull Request to integrate the branch into the master branch of your origin fork
Create GitHub Pull Request to integrate into the master branch of the upstream Peerism repository
Switch to master branch on your local computer git checkout master
Pull latest changes from master branch of remote origin (fork): git pull origin master
Rebase with remote upstream Peerism repository git pull --rebase upstream master
Update local branch interactively with latest remote changes git checkout <insert_branch_name>; git rebase -i master
- After resolving each merge conflicts run: git add <filename>; git rebase --continue
- Abort rebasing with: git rebase --abort

Code

Write tests and code tasks on Trello Board
Close-out Issues on Peerism GitHub repository

Chapter 2 - Non-Developers

Tasks

Create tasks on Trello Board