Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
29 lines (23 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

29 lines (23 loc) · 1.47 KB

Contributing

Code/ Style Conventions

  • Code should follow Microsoft's C# code conventions
  • Classes should use file-scoped namespaces and be in the format NHS.CohortManager.<Tests>.Service
    i.e NHS.CohortManager.CohortDistributionService
  • Test names should follow the convention NameOfMethod_Scenario_ExpectedResult

Pull Requests

  • Commit names should follow the conventional commits standard
    i.e refactor: move class out of shared
  • Branch names should follow the following format:
    type/DTOSS-<ticket-number>-<pr-description>
    i.e fix/DTOSS-1234-fixed-a-bug
  • Pull request names should follow the same conventional commits standard as commits
  • Write a bullet point description of the changes made in your PR
  • Add a link to the ticket in the context section as well as any other context
    you think would be helpful for reviewers to know
  • PR comments are to be marked resolved by the reviewer, not the author

Making A New Function

  1. Write the function & tests
  2. Add XML docs
  3. Create a Dockerfile and add to the relevant compose file
  4. Add a health check
  5. Update Terraform (or ask the platform team to do it)