Skip to content

Commit 4b1bb5d

Browse files
committed
Improve issue template and add pull_request_template
1 parent 1aca68c commit 4b1bb5d

File tree

4 files changed

+82
-12
lines changed

4 files changed

+82
-12
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
What would you like to do?
2+
3+
# Report a bug?
4+
5+
[] Title - Your title is clear and to the point
6+
7+
**Steps to reproduce:**
8+
1.
9+
2.
10+
11+
**Expected behavior:**
12+
13+
14+
**Actual behavior:**
15+
16+
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
17+
18+
# Create a new feature ticket?
19+
20+
[] Title - Your title is clear and to the point
21+
22+
**Description**
23+
What is the task about? Please give enough context for people to take on this task efficiently.
24+
25+
**Files**
26+
Is this a front-end or a backend ticket?
27+
What files is this likely to affect? Help your team dive right in!
28+
29+
**Acceptance Criteria**
30+
31+
[] Item 1
32+
[] Item 2
33+
34+
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
35+
36+
37+
**Labels**
38+
Once you are satisified with your Bug or Task ticket, assign the correct labels.
39+
Here are a few examples: `frontend`, `backend`, `good first issue`, `priority`, `feature`, `enhancement`.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
Hello, and thanks for contributing to <%= name %>!
2+
3+
## TL;DR
4+
5+
There are three main goals in this document, depending on the nature of your PR:
6+
7+
- [description](#description): tell us about your PR.
8+
- [checklist](#checklist): review the checklist that is most closely related to your PR.
9+
- [qa](#qa): update the qa checklist for your reviewers.
10+
11+
12+
## Title
13+
Add a clear title using an action verb.
14+
If it closes an issue, refer to it in your PR title by stating `closes #117` at the end.
15+
16+
## Description
17+
To help others to quickly understand the nature of your pull request, please create a description that incorporates the following elements:
18+
19+
- [] What is accomplished by the PR.
20+
- [] If you think some decisions may raise questions or require discussion, please state them and explain your choices.
21+
22+
23+
## Checklist
24+
Please use this checklist to verify that you took all the necessary steps.
25+
26+
- [ ] If closing an issue, all acceptance criteria are met.
27+
- [ ] All existing unit tests are still passing.
28+
- [ ] Add new passing unit tests to cover the code introduced by your PR and maintain test coverage.
29+
- [ ] Update the readme if needed.
30+
- [ ] Update or add any necessary API documentation.
31+
32+
33+
## QA
34+
When your PR is created, it is important to select a reviewer with knowledge of the code that has been changed.
35+
It is also useful to guide reviewers, to this extent, please complete this QA list with areas that could be affected by your changes.
36+
37+
Dear reviewer, please perform the following QA steps before approving my lovely PR:
38+
- [ ] The app loads nominally.
39+
- [ ] Select service area using the county selector.
40+
- [ ] Upload a service area csv (FIX DATASET).
41+
- [ ] Upload a provider csv (FIX DATASET).
42+
- [ ] Verify that `NEW FEATRURE` works as expected, i.e. `DETAILS`.

ISSUE_TEMPLATE.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
[build]: https://img.shields.io/circleci/project/bayesimpact/tds.svg?branch=master&style=flat-square
44
[apache2]: https://img.shields.io/badge/License-Apache%202.0-blue.svg
5+
[![Waffle.io - Columns and their card count](https://badge.waffle.io/bayesimpact/tds.svg?columns=all)](http://waffle.io/bayesimpact/tds)
56

67
> Explore Healthcare network adequacies and population distance to services.
78

0 commit comments

Comments
 (0)