From 4b1bb5d77953c60628bfc52657867710a9abc03e Mon Sep 17 00:00:00 2001 From: Eric Boucher Date: Fri, 12 Jan 2018 11:22:08 -0800 Subject: [PATCH] Improve issue template and add pull_request_template --- .github/ISSUE_TEMPLATE.md | 39 +++++++++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 42 ++++++++++++++++++++++++++++++++ ISSUE_TEMPLATE.md | 12 --------- README.md | 1 + 4 files changed, 82 insertions(+), 12 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 ISSUE_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..0d3a4311 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -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`. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..b9d720ae --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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`. diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md deleted file mode 100644 index f458fa5e..00000000 --- a/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,12 +0,0 @@ -**Steps to reproduce:** - -1. -2. -3. - -**Expected behavior:** - - - -**Actual behavior:** - diff --git a/README.md b/README.md index 972eb7b2..33855e14 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ [build]: https://img.shields.io/circleci/project/bayesimpact/tds.svg?branch=master&style=flat-square [apache2]: https://img.shields.io/badge/License-Apache%202.0-blue.svg +[![Waffle.io - Columns and their card count](https://badge.waffle.io/bayesimpact/tds.svg?columns=all)](http://waffle.io/bayesimpact/tds) > Explore Healthcare network adequacies and population distance to services.