Coding Standards - luney-sp-76/SaveThePlanetSE1 GitHub Wiki

Navigation:
This Page:Coding Standards
Home

Purpose: To maintain an agreed standard and format for the projects code.

Areas: Classes, Branches, Commits and JUnit

  1. Classes
    Classes Should be named after the Domain Model and marked with the current level with the Software Architecture - ie Presentation, Application or Data

  2. Branches
    Branches Should be labelled with the Use Case Code - And the function that is being created or amended, eg U-01 - Start Game - Welcome Message

  3. Commits
    Commits should be commented in the format - Update what I have changed or created. The commits should be made on a branch named after the ticket from the Kanban board which is named after the Use Case Descriptions and requests should be assigned and reviewed by 2 other people in the Team.

  4. JUnit
    Tests Should be named after the Classes under test

⚠️ **GitHub.com Fallback** ⚠️