From bd507c4c376cc4a116259fe6123afc5230a68158 Mon Sep 17 00:00:00 2001 From: Oliver Gugger Date: Mon, 3 Oct 2022 18:23:40 +0200 Subject: [PATCH 1/3] GitHub: move default template to bug_report.md, add config With this commit we prepare for adding multiple issue templates to GitHub that will be shown when the user clicks on the "New Issue" button on GitHub. The config.yml will also add a bunch of useful links to the page that shows the different issue templates. An example of how this template selection page looks like can be found here: https://github.com/lightninglabs/lightning-terminal/issues/new/choose --- .../bug_report.md} | 8 ++++++++ .github/ISSUE_TEMPLATE/config.yml | 11 +++++++++++ 2 files changed, 19 insertions(+) rename .github/{ISSUE_TEMPLATE.md => ISSUE_TEMPLATE/bug_report.md} (69%) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE/bug_report.md similarity index 69% rename from .github/ISSUE_TEMPLATE.md rename to .github/ISSUE_TEMPLATE/bug_report.md index ce42ab33b..b3eba1d77 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,3 +1,11 @@ +--- +name: Bug report +about: Create a bug report. Please use the discussions section for general or troubleshooting questions. +title: '[bug]: ' +labels: ["bug", "needs triage"] +assignees: '' +--- + ### Background Describe your issue here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..a2c5c9658 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: false +contact_links: + - name: Documentation for lnd and lightning-terminal + url: https://docs.lightning.engineering/ + about: Please make sure the documentation cannot answer your question first. + - name: Lightning Community Slack + url: https://lightning.engineering/slack.html + about: Please ask and answer questions here. + - name: Security issue disclosure policy + url: https://github.com/lightningnetwork/lnd#security + about: Please refer to this document when reporting security related issues. From f5a3b735f6895f2b2fb7e8dbda3494340875b900 Mon Sep 17 00:00:00 2001 From: Oliver Gugger Date: Mon, 3 Oct 2022 18:29:06 +0200 Subject: [PATCH 2/3] GitHub: add template for feature requests --- .github/ISSUE_TEMPLATE/feature_request.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..ed8bfb30d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,19 @@ +--- +name: Feature request +about: Suggest a new feature for `lnd`. +title: '[feature]: ' +labels: enhancement +assignees: '' +--- + +**Is your feature request related to a problem? Please describe.** + + +**Describe the solution you'd like** + + +**Describe alternatives you've considered** + + +**Additional context** + From 9eaf0cb73f1e2136591fa980711d8f5eaf098648 Mon Sep 17 00:00:00 2001 From: Oliver Gugger Date: Mon, 3 Oct 2022 18:30:29 +0200 Subject: [PATCH 3/3] GitHub: add link to discussions [skip ci] --- .github/ISSUE_TEMPLATE/config.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index a2c5c9658..a04ad5ae3 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,8 @@ blank_issues_enabled: false contact_links: + - name: Discussions + url: https://github.com/lightningnetwork/lnd/discussions + about: For general or troubleshooting questions or if you're not sure what issue type to pick. - name: Documentation for lnd and lightning-terminal url: https://docs.lightning.engineering/ about: Please make sure the documentation cannot answer your question first.