From e8a9fc66b4270bfc76768ae6a5b225144fa09c41 Mon Sep 17 00:00:00 2001 From: Romain Date: Mon, 29 May 2017 17:34:19 +1000 Subject: [PATCH] Github contribution templates --- .github/CONTRIBUTING.md | 23 ++++++++++++++++++ .github/ISSUE_TEMPLATE.md | 40 ++++++++++++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 11 +++++++++ 3 files changed, 74 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..5f73728 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,23 @@ + +Please make sure the tests are passing when submitting a code change: + +```bash +cd ~/thumbsup +npm install +./scripts/cibuild +``` + +For more confidence, you can also run `thumbsup` against the demo galleries at https://github.com/thumbsup/demos + +```bash +# prepare local thumbsup for linking +cd ~/thumbsup +npm install +npm link + +# link into the demos and make the galleries +cd ~/demos +npm install +npm link thumbsup +./build +``` diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..8f4cf07 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,40 @@ + + + + +## Feature request + +Please describe the new feature or behaviour you'd like to see. +If possible, give a concrete use case. + +## Bug report + +If running as an npm package: + +``` +Thumbsup version: __________ +Node version: __________ +NPM version: __________ +Operating system: __________ +``` + +If running as a Docker container: + +``` +Thumbsup image tag: __________ +Docker version: __________ +Operating system: __________ +``` + +About the bug... + +- Are you getting an error message? +- Have you tried running `DEBUG="*" thumbsup ` to get more troubleshooting info? +- Is the behavior different from expected? +- Can you provide steps to reproduce the issue? diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..c9d625e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,11 @@ + + + +- What's the current behaviour? +- What does the PR change? +- Does it introduce a breaking change for existing users?