Skip to content

Pull Request Naming and Description Convention

Ekunola Ezekiel edited this page Dec 13, 2019 · 1 revision

PR Naming

#story Title

Example

Build HQ for meetings

PR Description Template (Markdown)

The description should contain the following headings and the related content:

#### What does this PR do?
#### Description of Task to be completed?
#### How should this be manually tested?
#### What are the relevant Trello stories?
#### Relevant Screenshots (if appropriate)
#### Questions:
- [ ] I have performed a self-review of my own code
- [ ] My code follows the style guidelines of this project
- [ ] I have commented on my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works.
- [ ] New and existing unit tests pass locally with my changes
Clone this wiki locally