Skip to content

Latest commit

 

History

History
19 lines (17 loc) · 1.14 KB

WORKFLOW.md

File metadata and controls

19 lines (17 loc) · 1.14 KB

For contributors unfamiliar with working on shared github repositories, the safe workflow is:

  • Fork the repo, clone your fork to local machine
  • Working on the repo? New branch for a new feature:
    • git branch mynewbranchname
    • git checkout mynewbranchname
    • Do work, commit work, then push work with git push -u origin mynewbranchname
  • Head to github and send a pull request. It should even have noticed that you pushed a new branch and prompt you.
  • When your PR is merged, update your master from the upstream

Why not work from your master branch? Well, depending on how stuff gets merged with the upstream master (merge commit, rebase, squash) and you update (pull, pull with rebase) you can end up with either extra commits or conflicting commits. The above workflow avoids those issues and keeps updates organized, at the cost of a little bit of extra work.