Repository Management

When starting a new project, a new repository must be created on the version control system service (GitHub). To ensure all the projects are set up following best practices, the below guidelines must be applied.

When inheriting an existing code repository, the team must also work towards following the standard configuration.

Naming

Suffix the repository name with the platform name. The latter refers to the core tech stack that the application is built with: ex. {project-name}-{platform-name}.

DON'T

project-name
project-name-frontend
project-name-backend
project-name-js
project-name-store

DO

project-name-bigcommerce
project-name-wordpress
project-name-shopify
project-name-web
project-name-api

Branches

The primary branches develop and master must exist at all times.

The default branch must be set to develop. Every pull request can thus have develop as the destination branch by default, which is the desired outcome in 99.9% of the cases.

Branch protection rules for both branches must be implemented to:

• Enforce a pull request workflow to merge code to develop and master.
• Avoid developers pushing commits directly to develop and master.
• Avoid the deletion of develop and master by mistake.
• Require conversation resolution before merging

[dm]*[pr]