From 9c95249dcd6089be22f3b3bf5dd49301d5b7db6b Mon Sep 17 00:00:00 2001 From: Jason Dreyzehner Date: Mon, 13 Feb 2017 19:29:43 -0500 Subject: [PATCH] feat(github): add sample GitHub issue template, PR template, and contributing guidelines --- .github/CONTRIBUTING.md | 3 +++ .github/ISSUE_TEMPLATE.md | 11 +++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 13 +++++++++++++ .npmignore | 1 + 4 files changed, 28 insertions(+) create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..5ac541a --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,3 @@ +# Example Contributing Guidelines + +This is an example of GitHub's contributing guidelines file. Check out GitHub's [CONTRIBUTING.md help center article](https://help.github.com/articles/setting-guidelines-for-repository-contributors/) for more information. diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..3b7c28f --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,11 @@ +* **I'm submitting a ...** +[ ] bug report +[ ] feature request +[ ] question about the decisions made in the repository +[ ] question about how to use this project + +* **Summary** + + + +* **Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. StackOverflow, personal fork, etc.) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..caae6b1 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,13 @@ +* **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...) + + + +* **What is the current behavior?** (You can also link to an open issue here) + + + +* **What is the new behavior (if this is a feature change)?** + + + +* **Other information**: diff --git a/.npmignore b/.npmignore index ac5db83..705cbd3 100644 --- a/.npmignore +++ b/.npmignore @@ -2,6 +2,7 @@ src tsconfig.json tslint.json .travis.yml +.github coverage .nyc_output