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

Planning

  • Milestones should be created for a longer goal.
  • Sprints should be a week long and can arc over multiple milestones. Anything in a Sprint must be finished and reviewed by the end of the week.
  • 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.
  • Tickets should also be labeled with a size and the repository that they are relevant to (Grub, Semaphore, Flare, etc.).
  • Bug tickets should include how to reproduce the bug as well as the severity of it; in addition to any notes you might have.

Meetings

  • Pre Meeting Meeting: A meeting to organize the agenda for the weekly meeting and outline discussion priorities.
    • Friday 1:30 PM - 2:00 PM
  • Ops Weekly Meeting: A meeting with our advisors to go over what was done that week and discuss blocks and future plans.
    • Friday 2:00 PM - 3:30 PM
  • Stand Up Meetings: Meetings to keep each other on track throughout the week!
    • Tuesday and Thursday 9:00 AM - 9:20 AM

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.
  • Pull requests should include a small blurb about how the task was completed as well as a testing section that instructs other members of the team on how to test the code.
  • 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.