Business Rules! - conrad-blucher-institute/semaphore GitHub Wiki

Planning

• Milestones should be created for a sprint or a longer (Semester wide) goal.
• Anything on the Next or Now, of the project board page, (That is not a bug) should be added to a current Milestone.
• Tickets are required to a have a few sentences explaining what they are. Someone should be able to pick it up without asking the author. Try to add any notes, questions you have, or things you want to talk about on the ticket as you go.
• Bug tickets should include how to reproduce the bug as well as the severity of it; in addition to any notes you might have.

Dev Practices

• A ticket that requires code is finished with a PR (Pull Request). PR's need two reviews from other developers before being merged.
• Any new feature developed should have tests written to go along with it.
• Functions require Pylance type documentation and function documentation.
• Files require a file header.
• Nothing should be published to dev without going through a pull request first!
• No manual edits in sherlock-dev or sherlock-prod

Reviews

• A review should include some substantial comment.
• A review requires you to take the branch and at the very least run the tests on your machine.
• Try to signal needing a review or having finished one to your teammates.