-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from BC-MAR-21-ROR/feature#0_Git_templates
Feature#0 git templates
- Loading branch information
Showing
2 changed files
with
41 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
--- | ||
name: BrightCoders Issue Template | ||
about: BrightCoders standard issue template | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
# REQUIREMENTS | ||
Write a detailed description for this issue, provide all necessary information so any member of the project understands | ||
|
||
# DESIGN | ||
Provide references to images of the design, how it looks like now, and how it should look like. | ||
|
||
# Acceptance Criteria | ||
List all required acceptance criteria | ||
- [ ] Criteria 1 | ||
- [ ] Criteria 2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Description | ||
What did you implemented/Why did you implemented this: | ||
- Explain the changes you’ve made. | ||
- It doesn’t need to be fancy and you don’t have to get to technical, yet. | ||
- Just explicit what you have implemented at a high level. | ||
- Let the reviewer know the overall effect of the PR. | ||
- Reference a ticket in your issue tracker. Explain what the change is and then and only then reference the ticket. | ||
- The “why” is a chance to explain both the engineering goal, but also a some business objective that is satisfied or moved along. | ||
|
||
Examples: | ||
- What?: I've added support for authentication to implement Key Result 2 of OKR1. It includes | ||
model, table, controller and test. For more background, see ticket #JIRA-123. | ||
- Why?: These changes complete the user login and account creation experience. See #JIRA-123 for more information. | ||
|
||
# Testing | ||
Help me how can I test or look at the changes | ||
|
||
Example: | ||
- I've added coverage for testing all new methods. I used Faker for a few random user emails and names. | ||
|
||
## Screenshots | ||
If applicable, include screenshots of the results or screenshots that help to see changes |