From ed0938932813b3640cdaa94ea3e4ae5dab108031 Mon Sep 17 00:00:00 2001 From: Mike Murray Date: Tue, 14 Apr 2020 10:17:50 -0700 Subject: [PATCH] chore: add github issue templates Signed-off-by: Mike Murray --- .github/ISSUE_TEMPLATE/bug.md | 41 +++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++++ .github/ISSUE_TEMPLATE/corework.md | 13 +++++++++ .github/ISSUE_TEMPLATE/questions.md | 14 ++++++++++ .github/pull_request_template.md | 26 ++++++++++++++++++ 5 files changed, 99 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/corework.md create mode 100644 .github/ISSUE_TEMPLATE/questions.md create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md new file mode 100644 index 0000000..e6f6634 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -0,0 +1,41 @@ +--- +name: Bug Report +about: Something not up to standard? Let us know! +labels: 'bug, needs triage' +--- + + + +## Issue Description + + +## Steps to Reproduce + +1. +2. +3. + +## Possible Solution + + + +### Versions + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..789ec46 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Gitter chat + url: https://gitter.im/reactioncommerce/reaction + about: Please ask and answer questions here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/corework.md b/.github/ISSUE_TEMPLATE/corework.md new file mode 100644 index 0000000..c60e253 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/corework.md @@ -0,0 +1,13 @@ +--- +name: Core Work +about: Reaction team development work ticket tracker +labels: 'core work' +--- + + + + diff --git a/.github/ISSUE_TEMPLATE/questions.md b/.github/ISSUE_TEMPLATE/questions.md new file mode 100644 index 0000000..3356f7c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/questions.md @@ -0,0 +1,14 @@ +--- +name: ❓ Questions/Help +about: If you have questions, please check our gitter chat +labels: 'questions' +--- + +## ❓ Questions and Help + +### Please note that this issue tracker is not a help form and this issue will be closed. + +Please contact us instead. We are active in gitter and twitter: + +- [Gitter](https://gitter.im/reactioncommerce/reaction) +- [Twitter](https://twitter.com/getreaction) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..c5aee88 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,26 @@ +Resolves #issueNumber +Impact: **breaking|critical|major|minor** +Type: **feature|bugfix|performance|test|style|refactor|docs|chore** + +## Issue +Description of the issue this PR is solving, why it's happening, and how to reproduce it. This may differ from the original ticket as you now have more information at your disposal. + +## Solution +Summarize your solution to the problem. Please include short descriptions of any solutions you tested before arriving at your final solution. This will help reviewers know why you decided to solve this problem in this particular way and will speed up the review process. + +If you're solving a UIX related issue, please attach screen-caps or gifs showing how your solution differs from the issue. + +## Breaking changes +If you have a breaking changes, list them here, otherwise list none. + +Examples of breaking changes include changing file names, moving files, deleting files, renaming functions or exports, or changes to code which might cause previous versions of Reaction or third-party code not to work as expected. + +Note any work that you did to mitigate the effect of any breaking changes such as creating migrations, deprecation warnings, etc. + + +## Testing +1. List the steps needed for testing your change in this section. +2. Assume that testers already know how to start the app, and do the basic setup tasks. +3. Be detailed enough that someone can work through it without being too granular + +More detail for what each of these sections should include are available in our [Contributing Docs](https://docs.reactioncommerce.com/reaction-docs/trunk/contributing-to-reaction)