-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve issue template and add pull_request_template
- Loading branch information
1 parent
1aca68c
commit 4b1bb5d
Showing
4 changed files
with
82 additions
and
12 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,39 @@ | ||
What would you like to do? | ||
|
||
# Report a bug? | ||
|
||
[] Title - Your title is clear and to the point | ||
|
||
**Steps to reproduce:** | ||
1. | ||
2. | ||
|
||
**Expected behavior:** | ||
|
||
|
||
**Actual behavior:** | ||
|
||
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ | ||
|
||
# Create a new feature ticket? | ||
|
||
[] Title - Your title is clear and to the point | ||
|
||
**Description** | ||
What is the task about? Please give enough context for people to take on this task efficiently. | ||
|
||
**Files** | ||
Is this a front-end or a backend ticket? | ||
What files is this likely to affect? Help your team dive right in! | ||
|
||
**Acceptance Criteria** | ||
|
||
[] Item 1 | ||
[] Item 2 | ||
|
||
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ | ||
|
||
|
||
**Labels** | ||
Once you are satisified with your Bug or Task ticket, assign the correct labels. | ||
Here are a few examples: `frontend`, `backend`, `good first issue`, `priority`, `feature`, `enhancement`. |
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,42 @@ | ||
Hello, and thanks for contributing to <%= name %>! | ||
|
||
## TL;DR | ||
|
||
There are three main goals in this document, depending on the nature of your PR: | ||
|
||
- [description](#description): tell us about your PR. | ||
- [checklist](#checklist): review the checklist that is most closely related to your PR. | ||
- [qa](#qa): update the qa checklist for your reviewers. | ||
|
||
|
||
## Title | ||
Add a clear title using an action verb. | ||
If it closes an issue, refer to it in your PR title by stating `closes #117` at the end. | ||
|
||
## Description | ||
To help others to quickly understand the nature of your pull request, please create a description that incorporates the following elements: | ||
|
||
- [] What is accomplished by the PR. | ||
- [] If you think some decisions may raise questions or require discussion, please state them and explain your choices. | ||
|
||
|
||
## Checklist | ||
Please use this checklist to verify that you took all the necessary steps. | ||
|
||
- [ ] If closing an issue, all acceptance criteria are met. | ||
- [ ] All existing unit tests are still passing. | ||
- [ ] Add new passing unit tests to cover the code introduced by your PR and maintain test coverage. | ||
- [ ] Update the readme if needed. | ||
- [ ] Update or add any necessary API documentation. | ||
|
||
|
||
## QA | ||
When your PR is created, it is important to select a reviewer with knowledge of the code that has been changed. | ||
It is also useful to guide reviewers, to this extent, please complete this QA list with areas that could be affected by your changes. | ||
|
||
Dear reviewer, please perform the following QA steps before approving my lovely PR: | ||
- [ ] The app loads nominally. | ||
- [ ] Select service area using the county selector. | ||
- [ ] Upload a service area csv (FIX DATASET). | ||
- [ ] Upload a provider csv (FIX DATASET). | ||
- [ ] Verify that `NEW FEATRURE` works as expected, i.e. `DETAILS`. |
This file was deleted.
Oops, something went wrong.
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