GitHub Repository Standards
Creating a Repository
Whenever you create a new repository, make sure to notify the Director of Technology so that they can link it to YouTrack. This then shows all commit history in the issue tracker, which is very useful for understanding the history of a project.
Readme File
Always include a README.md that includes the following:
A brief introduction of the purpose of the repository/app
(if applicable) How to run the code locally
Directory structure - i.e. how to find what you need
The process for develop > build > test
(if applicable) Unit tests and when they should be run before deployment
How to deploy the project
Charts
Use Mermaidto build charts
Branch Naming
Name branches after the issue number that they are addressing. For example, if you are working on issue PORTAL-103, your branch name must start with PORTAL-103. It is often helpful to include a brief description of the issue in the branch name as well.