Skip to content
StevenElberger edited this page Oct 1, 2014 · 1 revision

Repository Guidelines

Please take these guidelines into consideration when developing!

No Modifying the Master Branch

  • This keeps things looking neat and creates an organized workflow we can all follow.
  • The master branch is to hold stable, tested, and integrated code only!
  • It will only be touched during the integration and testing phases.

Only Develop Your Designated Branch*

  • Sticking to one branch will reduce confusion when it comes to system integration.
  • This allows for more developer freedom as the number of merges will be reduced.
  • Pushes may be made more frequently without worrying about breaking another developer's code.

*This is just a guideline. Feel free to collaborate, but take responsibility for your code & merges!

Do Not Remove Public Commits

  • Amending public commits or doing hard resets are forbidden for a good reason!
  • This will cause serious and messy conflicts later down the road.
  • It is also considered good practice not to do such things. (Please look at alternative methods)

Use the GitHub Issue Tracker

  • This tool is invaluable because it allows the tracking of more than just software bugs!
  • Use this tool as much as possible not only to keep track of your issues, but to be open with the team about them.
  • Please also write as much of a detailed description about your issues as possible.

Ask For Help

  • Not really just a repository guideline, but please be open with the rest of the team. We need to mark progress!
  • Issues pertaining to software are just the tip of the iceberg. If you're confused, please ask a team member.
  • Open a "help wanted" issue when asking for help in case other members are more readily available.

Clone this wiki locally