Skip to content

Commit

Permalink
Add issue & pull request templates (#6)
Browse files Browse the repository at this point in the history
  • Loading branch information
DmyMi authored Jan 21, 2021
1 parent 23da0a3 commit 424fbcc
Show file tree
Hide file tree
Showing 8 changed files with 515 additions and 0 deletions.
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
name: Bug report
about: Create a report to help us improve
title: '[Affected functionality] Clear and concise summary, e.g. "[Create news] ''Publish''
button is not displayed on the ''Preview'' page"'
labels: bug
assignees: ''

---

**Environment:** OS, browser, it's version, device (for mobile devices).
**Reproducible:** always, rarely, sometimes etc.
**Build found:** last commit from https://github.com/ita-social-projects/OoS-Backend/tree/main
E.g. "commit 147fa44"

**Preconditions**
A clear and concise description of actions to be done before the start of the bug reproducing (to make bug reproducing possible). E.g.:
"Create an item in the database using SQL query:
INSERT INTO table1 (column1, column2)
VALUES (value1, value2);"

**Steps to reproduce**
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'

**Actual result**
A clear and concise description of what happened (displayed, not displayed etc.)
Attached bug screenshots or video recorded.

**Expected result**
A clear and concise description of what you expected to happen.
Attached screenshots or mock-ups if available.

**Postconditions**
A clear and concise description of actions to be done after bug reproducing. E.g.:
"Delete created item from database using SQL query:
DELETE FROM table1
WHERE id=<item1_id>;"

**User story and test case links**
E.g.: "User story #100
[Test case]([#100 Story](https://github.com/ita-social-projects/OoS-Backend/issues/100))"

**Labels to be added**
"Bug", Priority ("pri: "), Severity ("severity:"), Type ("UI, "Functional"), "API" (for back-end bugs).
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/custom_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: Custom template
about: Blank template for other issue types
title: ''
labels: ''
assignees: ''

---
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/task.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Task
about: Describe task
title: ''
labels: ''
assignees: ''

---

**Story link**
[#100 Story](https://github.com/ita-social-projects/OoS-Backend/issues/100)

### Task description
Show priority posts by api request

### To do
1. - [ ] Implement api endpoint contorller for getting posts.
2. - [ ] Implement service for getting all priority posts.
3. - [ ] Implement repository for getting all priority posts.


### [Estimating](https://example.com)
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/user-story.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: User story
about: Describe story goal
title: ''
labels: ''
assignees: ''

---

**As a** <role> **I want to** <....> **so that** <...>

**Description**
Describe feature functionality
Add mockup if needed

### Acceptance Criteria
A clear and concise description of what you want to happen.

**Epic link**
E.g.: Epic #100 [Epic](https://github.com/ita-social-projects/OoS-Backend/labels/100)

**Labels to be added**
"User story", Correspondind Functionality (e.g. User), Priority ("pri: "), "Corresponding Epic"

### Tasks
1. - [ ] sample task.
37 changes: 37 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/develop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
develop
## GitHub Board

**Issue link**

[#100 Issue name ](https://github.com/ita-social-projects/OoS-Backend/issues/100)

**Story link**

[#100 Story](https://github.com/ita-social-projects/OoS-Backend/issues/100)

## Code reviewers

- [ ] @github_username

### Second Level Review

- [ ] @github_username

## Summary of issue

ToDo

## Summary of change

ToDo

## Testing approach

ToDo
## CHECK LIST
- [ ] СI passed
- [ ] Сode coverage >=80%
- [ ] PR is reviewed manually again (to make sure you have 100% ready code)
- [ ] All reviewers agreed to merge the PR
- [ ] I've checked new feature as logged in and logged out user if needed
- [ ] PR meets all conventions
37 changes: 37 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/main.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
main
## GitHub Board

**Issue link**

[#100 Issue name ](https://github.com/ita-social-projects/OoS-Backend/issues/100)

**Story link**

[#100 Story](https://github.com/ita-social-projects/OoS-Backend/issues/100)

## Code reviewers

- [ ] @github_username

### Second Level Review

- [ ] @github_username

## Summary of issue

ToDo

## Summary of change

ToDo

## Testing approach

ToDo
## CHECK LIST
- [ ] СI passed
- [ ] Сode coverage >=80%
- [ ] PR is reviewed manually again (to make sure you have 100% ready code)
- [ ] All reviewers agreed to merge the PR
- [ ] I've checked new feature as logged in and logged out user if needed
- [ ] PR meets all conventions
Loading

0 comments on commit 424fbcc

Please sign in to comment.