Git naming conventions and best practices - andela/asgard-rc GitHub Wiki

Branch naming

Branches should be created using the following name format:

{story type}-{2-3 word summary}-{pivotal tracker id}

story-type - Indicates the context of the branch and should be one of:

• ft === Feature
• bg === Bug
• ch === Chore

story-summary - Short 2-3 words summary about what the branch contains

Example

ft-resources-rest-endpoints-111504508

PR Description Template (Markdown)

The description of the PR should contain the following headings and their corresponding content in Markdown format.

#### What does this PR do?
#### Description of Task to be completed?
#### How should this be manually tested?
#### Any background context you want to provide?
#### What are the relevant pivotal tracker stories?
#### Screenshots (if appropriate)

Example

Commits

Commits should be atomic and they should be made with the format:

story-type(scope): short commit heading

- description of task 1 that has been implemented.
- description of task 2 that has been implemented.

[footer-text #story-id]

story-type - Indicates the context of the branch, should be one of:

• feat
• bug
• chore

footer-text - Indicates the state of the task, should be either of:

• Finishes - used for both chores and bugs
• Delivers - used for features

Note - all texts should be in lowercase, except for the scope that can be camel cased

Example

feat(readmeFile): add circle ci badge

- add the circle ci badge markdown to top of readme file.

[Delivers #15543353]