From 23d056c0540256387604394f8dacfe909f897b43 Mon Sep 17 00:00:00 2001 From: Zac Sweers Date: Mon, 1 Feb 2021 18:00:03 -0500 Subject: [PATCH] Add issue templates (#1254) --- .github/ISSUE_TEMPLATE/bug_report.md | 13 +++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 +++++ .github/ISSUE_TEMPLATE/feature_request.md | 12 ++++++++++++ 3 files changed, 30 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..9a0511c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,13 @@ +--- +name: Bug report +about: A reproducible problem +title: '' +labels: bug +assignees: '' + +--- + +Good bug reports include a failing test! Writing a test helps you to isolate and describe the problem, and it helps us to fix it fast. Bug reports without a failing test or reproduction steps are likely to be closed. + +Here’s an example test to get you started. +https://gist.github.com/ZacSweers/0ef2c5f0e3f61f82063dd8c67d75879f \ 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..1286af5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Question? + url: https://stackoverflow.com/questions/tagged/moshi + about: Please ask usage questions on Stack Overflow with the `moshi` tag. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..cda7fe0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,12 @@ +--- +name: Feature request +about: Suggest an idea +title: '' +labels: enhancement +assignees: '' + +--- + +Start by telling us what problem you’re trying to solve. Often a solution already exists! + +Don’t send pull requests to implement new features without first getting our support. Sometimes we leave features out on purpose to keep the project small. \ No newline at end of file