From a959ed99c2966dfc10ac41710eb74b7baf490bcf Mon Sep 17 00:00:00 2001 From: Gabriel Date: Wed, 15 Sep 2021 18:33:13 +0100 Subject: [PATCH] Issue template form (#16349) * Create issue template using new format This issue template has been based off of the current issue creation workflow defined in the ISSUE_TEMPLATE.md file This commit allows for that issue template (which is a legacy method of creating an issue) to be deleted * Delete old issue template file This commit deletes the old issue template file, as it is both legacy and replaced by ISSUE_TEMPLATE/issue.yaml * Adjust file upload and remove code of conduct checkbox * Block blank issue creation * Update feedback Removed most requirements Updated prompt to include instruction to state whether using try.gitea.io Added default value to Gitea version * Create Feature Request issue form * Update and rename issue.yaml to bug-report.yaml * Enable blank issue creation Co-authored-by: a1012112796 <1012112796@qq.com> * Update config.yaml * Remove default & placeholder from Gitea version * Create issue template in .gitea directory * Add relevant bug report message to feature request * Adjust name to remove banner There is a banner that tells you to create a config.yml when you already have a config.yaml Renaming the file stops this from occurring. * Add UI bug report form * Remove unnecessary question Co-authored-by: a1012112796 <1012112796@qq.com> Co-authored-by: techknowlogick Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: Lauris BH --- {.github => .gitea}/issue_template.md | 0 .github/ISSUE_TEMPLATE/bug-report.yaml | 89 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 17 ++++ .github/ISSUE_TEMPLATE/feature-request.yaml | 23 ++++++ .github/ISSUE_TEMPLATE/ui.bug-report.yaml | 62 ++++++++++++++ 5 files changed, 191 insertions(+) rename {.github => .gitea}/issue_template.md (100%) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yaml create mode 100644 .github/ISSUE_TEMPLATE/ui.bug-report.yaml diff --git a/.github/issue_template.md b/.gitea/issue_template.md similarity index 100% rename from .github/issue_template.md rename to .gitea/issue_template.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml new file mode 100644 index 00000000000..b0f88a98a60 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -0,0 +1,89 @@ +name: Bug Report +description: Found something you weren't expecting? Report it here! +body: +- type: markdown + attributes: + value: | + NOTE: If your issue is a security concern, please send an email to security@gitea.io instead of opening a public issue. +- type: markdown + attributes: + value: | + 1. Please speak English, this is the language all maintainers can speak and write. + 2. Please ask questions or configuration/deploy problems on our Discord + server (https://discord.gg/gitea) or forum (https://discourse.gitea.io). + 3. Please take a moment to check that your issue doesn't already exist. + 4. Make sure it's not mentioned in the FAQ (https://docs.gitea.io/en-us/faq) + 5. Please give all relevant information below for bug reports, because + incomplete details will be handled as an invalid report. +- type: input + id: gitea-ver + attributes: + label: Gitea Version + description: Gitea version (or commit reference) your instance is running + validations: + required: true +- type: input + id: git-ver + attributes: + label: Git Version + description: The version of git running on the server's systemm +- type: input + id: os-ver + attributes: + label: Operating System + description: The operating system you are using to run Gitea +- type: textarea + id: run-info + attributes: + label: How are you running Gitea? + description: | + Please include information on whether you built gitea yourself, used one of our downloads, are using https://try.gitea.io or are using some other package + Please also tell us how you are running gitea, e.g. if it is being run from docker, a command-line, systemd etc. + If you are using a package or systemd tell us what distribution you are using + validations: + required: true +- type: dropdown + id: database + attributes: + label: Database + description: What database system are you running? + options: + - PostgreSQL + - MySQL + - MSSQL + - SQLite +- type: dropdown + id: can-reproduce + attributes: + label: Can you reproduce the bug on the Gitea demo site? + description: | + If so, please provide a URL in the Description field + URL of Gitea demo: https://try.gitea.io + options: + - "Yes" + - "No" + validations: + required: true +- type: markdown + attributes: + value: | + It really is important to provide pertinent logs + Please read https://docs.gitea.io/en-us/logging-configuration/#debugging-problems + In addition, if your problem relates to git commands set `RUN_MODE=dev` at the top of app.ini +- type: input + id: logs + attributes: + label: Log Gist + description: Please provide a gist URL of your logs, with any sensitive information (e.g. API keys) removed/hidden +- type: textarea + id: description + attributes: + label: Description + description: | + Please provide a description of your issue here, with a URL if you were able to reproduce the issue (see above) + If using a proxy or a CDN (e.g. CloudFlare) in front of gitea, please disable the proxy/CDN fully and connect to gitea directly to confirm the issue still persists without those services. +- type: textarea + id: screenshots + attributes: + label: Screenshots + description: If this issue involves the Web Interface, please provide a screenshot or multiple screenshots diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000000..e79cc9d4328 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,17 @@ +blank_issues_enabled: true +contact_links: + - name: Security Concern + url: https://tinyurl.com/security-gitea + about: For security concerns, please send a mail to security@gitea.io instead of opening a public issue. + - name: Discord Server + url: https://discord.gg/gitea + about: Please ask questions and discuss configuration or deployment problems here. + - name: Discourse Forum + url: https://discourse.gitea.io + about: Questions and configuration or deployment problems can also be discussed on our forum. + - name: Frequently Asked Questions + url: https://docs.gitea.io/en-us/faq + about: Please check if your question isn't mentioned here. + - name: Crowdin Translations + url: https://crowdin.com/project/gitea + about: Translations are managed here. diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml new file mode 100644 index 00000000000..69b338ddf8d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yaml @@ -0,0 +1,23 @@ +name: Feature Request +description: Got an idea for a feature that Gitea doesn't have currently? Submit your idea here! +body: +- type: markdown + attributes: + value: | + 1. Please speak English, this is the language all maintainers can speak and write. + 2. Please ask questions or configuration/deploy problems on our Discord + server (https://discord.gg/gitea) or forum (https://discourse.gitea.io). + 3. Please take a moment to check that your feature hasn't already been suggested. +- type: textarea + id: description + attributes: + label: Feature Description + placeholder: | + I think it would be great if Gitea had... + validations: + required: true +- type: textarea + id: screenshots + attributes: + label: Screenshots + description: If you can, provide screenshots of an implementation on another site e.g. GitHub diff --git a/.github/ISSUE_TEMPLATE/ui.bug-report.yaml b/.github/ISSUE_TEMPLATE/ui.bug-report.yaml new file mode 100644 index 00000000000..deae94052e6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/ui.bug-report.yaml @@ -0,0 +1,62 @@ +name: Web Interface Bug Report +description: Something doesn't look quite as it should? Report it here! +body: +- type: markdown + attributes: + value: | + NOTE: If your issue is a security concern, please send an email to security@gitea.io instead of opening a public issue. +- type: markdown + attributes: + value: | + 1. Please speak English, this is the language all maintainers can speak and write. + 2. Please ask questions or configuration/deploy problems on our Discord + server (https://discord.gg/gitea) or forum (https://discourse.gitea.io). + 3. Please take a moment to check that your issue doesn't already exist. + 4. Make sure it's not mentioned in the FAQ (https://docs.gitea.io/en-us/faq) + 5. Please give all relevant information below for bug reports, because + incomplete details will be handled as an invalid report. +- type: input + id: gitea-ver + attributes: + label: Gitea Version + description: Gitea version (or commit reference) your instance is running + validations: + required: true +- type: input + id: os-ver + attributes: + label: Operating System + description: The operating system you are using to access Gitea +- type: input + id: browser-ver + attributes: + label: Browser Version + description: The browser and version that you are using to access Gitea + validations: + required: true +- type: dropdown + id: can-reproduce + attributes: + label: Can you reproduce the bug on the Gitea demo site? + description: | + If so, please provide a URL in the Description field + URL of Gitea demo: https://try.gitea.io + options: + - "Yes" + - "No" + validations: + required: true +- type: textarea + id: description + attributes: + label: Description + description: | + Please provide a description of your issue here, with a URL if you were able to reproduce the issue (see above) + If using a proxy or a CDN (e.g. CloudFlare) in front of gitea, please disable the proxy/CDN fully and connect to gitea directly to confirm the issue still persists without those services. +- type: textarea + id: screenshots + attributes: + label: Screenshots + description: Please provide at least 1 screenshot showing the issue. + validations: + required: true