Skip to content

Version Control

David Tuttle edited this page Dec 2, 2017 · 2 revisions

Version Control

General Procedures:

  • Version control is done through a GitHub repository
  • Programmers should not push directly to the “master” branch
  • Instead, they should create branches from the most recent version of “master” and work on those
  • No programmers should be working in the same branch
  • When you believe you are finished working on a task submit a PR and post a message to slack.
  • Another programmer should test and merge your PR.
  • The reviewer should contact the original programmer if changes are needed

Recommended Procedures:

  • Programmers should be using a visual Git tool (like SourceTree) or a Git command Line Tools to add their work to the repository
  • Branches should be named accordingly to type:
    • Fixes
      • [fix/name-of-bug]
      • Fixes are any bug fixing/debugging done to solve known issues in the project
    • Improvements
      • [improvement/aspect-of-program-improved]
      • Improvements are small changes that help the functionality/behaviour of the game
      • They are not directly related to bugs, but instead of housekeeping matters, such as refactoring or optimizing
    • Features
      • [feature/name-of-new-feature]
      • Features are new features/modules being added to the game
      • These should be the biggest changes of the three types of branches
Clone this wiki locally