Home

Project Guidelines

Getting started

• Initial setup

Accepting work

• All work is self-assigned
• Review the project board for unassigned To do issues
• To start working on an issue of interest:
  • Move the issue from To do to In progress
  • Assign the issue to yourself
    • Do not assign yourself multiple issues unless they are directly related and are actively In progress

Submitting Pull Requests

• Create a feature branch in your local clone
  • git checkout -b ${feature_branch}
• Make edits, commit and push to your fork
  • git commit --all -m "${commit_message}"
  • git push origin ${feature_branch}
• Submit pull request
  • From your fork, click green Compare & pull request button
• Code reviews
  • If you later need to add new commits to the pull request in response to a code review, you can simply commit the changes to the local branch and then use git push to automatically update the pull request.

Updating your Fork

After a pull request is merged, or any time you want to update your fork to include latest commits from this (upstream) repo:

• Pull upstream changes
  • git pull upstream master
• Push them to your fork
  • git push origin master

Updating someone else's Pull Request

• Download all branches from GitHub
  • git fetch
• View all branches
  • git branch -a
• Checkout a local copy of a remote branch
  • git checkout ${branch_name}
• Test code, make any changes and then commit and push changes
  • Make edits
  • git commit
  • git push