From 554dafd9764c4ae3ede65f57566d4f3199a65ec2 Mon Sep 17 00:00:00 2001 From: per1234 Date: Sun, 9 May 2021 02:47:43 -0700 Subject: [PATCH] Add issue templates Although I don't feel that templates themselves have any value for this project, the GitHub template system has some very useful features: - Template chooser allows redirecting support requests via "Contact Links", and also provides a prominent link to security policy to guide vulnerability disclosures. - Encouraging the reporter to fit their report into a specific category results in more clarity. - Automatic labeling according to template choice allows the reporter to do the initial classification. --- .github/ISSUE_TEMPLATE/bug-report.md | 7 +++++++ .github/ISSUE_TEMPLATE/config.yml | 7 +++++++ .github/ISSUE_TEMPLATE/feature-request.md | 7 +++++++ 3 files changed, 21 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 00000000..66171e13 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,7 @@ +--- +name: Bug report +about: Report problems with the code in this repository. +title: "" +labels: "type: imperfection" +assignees: "" +--- diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..eb5bf5ae --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,7 @@ +contact_links: + - name: Learn about the Arduino Library Manager indexer + url: https://github.com/arduino/library-registry/blob/main/FAQ.md#arduino-library-manager-faq + about: Frequently asked questions about the Library Manager indexer. + - name: Support request + url: https://forum.arduino.cc/ + about: We can help you out on the Arduino Forum! diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 00000000..f2557244 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,7 @@ +--- +name: Feature request +about: Suggest an improvement for this project. +title: "" +labels: "type: enhancement" +assignees: "" +---