Home

Welcome to the GatorGrouper wiki! Naming structure for branches off of master:

feature/i-<issue number>-<summary-of-issue>

Ex.

feature/i-1-command-line-arguments

Teams should branch off of their issue branches to split up tasks for addressing each issue To create a branch off of the issue branch:

$ git checkout feature/i-<issue number>-<summary-of-issue>
$ git checkout -b feature/<summary-of-task>

Each team can decide how to name the branches off of their own issue branches; however, it may be simplest to name it as in the example above.

Each pull request to merge into master requires the reviews and approvals of 4 out of 7 project managers.

---

Please include logging statements throughout your code so that users can verify that the program is running as expected and developers can more easily debug if something does go wrong. To log, include the following code (as they are needed) in your files:

# at the top of your file
import logging
...
logging.info("General (non-technical) comment about how the program is running. Used for normal behavior.")
logging.debug("More technical comment about how the program is running. May describe inputs and outputs of specific functions. Used for normal behavior")
logging.error("Comment about what went wrong in the program. Could be used within a catch block or conditional that checks for erroneous activity. Used for abnormal/deleterious behavior.")