From e4be33204fcc59ba0fd1b90bb642a185d410c240 Mon Sep 17 00:00:00 2001 From: Clay Diffrient Date: Fri, 8 Apr 2016 22:56:34 -0600 Subject: [PATCH] Add extra information for contributors (#143) This commit adds templates for pull requests and issues. The goal is to help those contributing to the project to get their issues handled quicker and their pull requests reviewed and merged quicker and more efficiently. --- .github/ISSUE_TEMPLATE.md | 12 ++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 16 ++++++++++++++++ CONTRIBUTING.md | 2 +- 3 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..8e6e3d60 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,12 @@ +### Summary: + +### Steps to reproduce: + + 1. + 2. + 3. + +### Expected behavior: + +### Additional notes: + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..65d6fe91 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,16 @@ +Fixes #[issue number]. + +Changes proposed: +- +- +- + +Upgrade Path (for changed or removed APIs): + + +Acceptance Checklist: +[ ] All commits have been squashed to one. +[ ] The commit message follows the guidlines in `CONTRIBUTING.md`. +[ ] Documentation (README.md) and examples have been updated as needed. +[ ] If this is a code change, a spec testing the functionality has been added. +[ ] If the commit message has [changed] or [removed], there is an upgrade path above. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4faf145d..5ea35781 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,7 +29,7 @@ always be in sync. ### Development - `npm start` runs the dev server to run/develop examples -- `npm test` will run the test. +- `npm test` will run the tests. - `scripts/test` same as `npm test` but keeps karma running and watches for changes