From 8524255a2edce3f44d0054eda120ed82388ffdba Mon Sep 17 00:00:00 2001 From: Alexis Date: Sat, 15 Feb 2025 07:50:20 +0900 Subject: [PATCH] [REPO] Create New Issue Template with Updated Strcuture (#10172) Playing around with the new [issue template structure](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms). If you'd like to test it out: https://github.com/zoracon/zoracon/issues/new?template=bug.yml --------- Co-authored-by: ohemorange Co-authored-by: ohemorange --- .github/ISSUE_TEMPLATE/bug.yaml | 69 +++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 7 ++++ .github/issue_template.md | 22 ---------- 3 files changed, 76 insertions(+), 22 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug.yaml delete mode 100644 .github/issue_template.md diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml new file mode 100644 index 000000000..ab06f9f10 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -0,0 +1,69 @@ +name: Bug Report +description: File a bug report. +title: "[Bug]: " +type: Bug +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! If you're + having trouble using Certbot and aren't sure you've found a bug, + please first try asking for help at https://community.letsencrypt.org/. + There is a much larger community there of people familiar with the + project who will be able to more quickly answer your questions. + - type: input + attributes: + label: OS + description: | + Describe your Operating System. Examples: Ubuntu 18.04, CentOS 8 Stream + placeholder: Ubuntu 24.04 + validations: + required: true + - type: input + attributes: + label: Installation method + description: | + How did you install Certbot? Examples: snap, pip, apt, yum + placeholder: snap + validations: + required: true + - type: input + attributes: + label: Certbot Version + description: | + If you're not sure, you can find this by running `certbot --version`. + placeholder: 1.0.0 + validations: + required: true + - type: textarea + id: what-happened + attributes: + label: What happened? + description: | + I ran this command and it produced this output. Example: + ``` + $ sudo certbot certonly -d adfsfasdf.asdfasdf --staging + Saving debug log to /var/log/letsencrypt/letsencrypt.log + Plugins selected: Authenticator nginx, Installer nginx + Requesting a certificate for example.com + An unexpected error occurred: + Invalid identifiers requested :: Cannot issue for "adfsfasdf.asdfasdf": Domain name does not end with a valid public suffix (TLD) + Ask for help or search for solutions at https://community.letsencrypt.org. See the logfile /var/log/letsencrypt/letsencrypt.log or re-run Certbot with -v for more details. + ``` + placeholder: Tell us what you see! + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected behavior + description: Certbot's behavior differed from what I expected because. + placeholder: "What was expected?" + validations: + required: true + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Here is a Certbot log showing the issue (if available). Logs are stored in `/var/log/letsencrypt` by default. Feel free to redact domains, e-mail and IP addresses as you see fit. + render: shell diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 3ba13e0ce..dc6a82633 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1 +1,8 @@ blank_issues_enabled: false +contact_links: + - name: Let's Encrypt Community Support + url: https://community.letsencrypt.org/ + about: If you're having trouble using Certbot and aren't sure you've found a bug or request for a new feature, please first try asking for help here. There is a much larger community there of people familiar with the project who will be able to more quickly answer your questions. + - name: Certbot Security Policy + url: https://github.com/certbot/certbot/security/advisories/new + about: Please report security vulnerabilities here. diff --git a/.github/issue_template.md b/.github/issue_template.md deleted file mode 100644 index 87ecddc6c..000000000 --- a/.github/issue_template.md +++ /dev/null @@ -1,22 +0,0 @@ -If you're having trouble using Certbot and aren't sure you've found a bug or -request for a new feature, please first try asking for help at -https://community.letsencrypt.org/. There is a much larger community there of -people familiar with the project who will be able to more quickly answer your -questions. - -## My operating system is (include version): - - -## I installed Certbot with (snap, OS package manager, pip, certbot-auto, etc): - - -## I ran this command and it produced this output: - - -## Certbot's behavior differed from what I expected because: - - -## Here is a Certbot log showing the issue (if available): -###### Logs are stored in `/var/log/letsencrypt` by default. Feel free to redact domains, e-mail and IP addresses as you see fit. - -## Here is the relevant nginx server block or Apache virtualhost for the domain I am configuring: