From 92acffb8d6e2b6ab348c68f9cbd039bf18f4062b Mon Sep 17 00:00:00 2001 From: autoantwort <41973254+autoantwort@users.noreply.github.com> Date: Fri, 7 Apr 2023 01:45:55 +0200 Subject: [PATCH] [issues] Use issue forms instead of markdown templates (#30605) --- .../00-report-package-build-failure.yml | 47 +++++++++++++++++++ .../ISSUE_TEMPLATE/01-request-a-new-port.yml | 36 ++++++++++++++ ...-request-an-update-to-an-existing-port.yml | 23 +++++++++ ...est-a-feature-or-improvement-to-a-port.yml | 29 ++++++++++++ .../04-request-a-feature-or-improvement.yml | 29 ++++++++++++ ...port.md => 05-other-type-of-bug-report.md} | 0 .github/ISSUE_TEMPLATE/config.yml | 5 ++ .github/ISSUE_TEMPLATE/i-have-a-question.md | 10 ---- .../report-package-build-failure.md | 33 ------------- ...uest-a-feature-or-improvement-to-a-port.md | 22 --------- .../request-a-feature-or-improvement.md | 22 --------- .github/ISSUE_TEMPLATE/request-a-new-port.md | 18 ------- .../request-an-update-to-an-existing-port.md | 14 ------ 13 files changed, 169 insertions(+), 119 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/00-report-package-build-failure.yml create mode 100644 .github/ISSUE_TEMPLATE/01-request-a-new-port.yml create mode 100644 .github/ISSUE_TEMPLATE/02-request-an-update-to-an-existing-port.yml create mode 100644 .github/ISSUE_TEMPLATE/03-request-a-feature-or-improvement-to-a-port.yml create mode 100644 .github/ISSUE_TEMPLATE/04-request-a-feature-or-improvement.yml rename .github/ISSUE_TEMPLATE/{other-type-of-bug-report.md => 05-other-type-of-bug-report.md} (100%) create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/i-have-a-question.md delete mode 100644 .github/ISSUE_TEMPLATE/report-package-build-failure.md delete mode 100644 .github/ISSUE_TEMPLATE/request-a-feature-or-improvement-to-a-port.md delete mode 100644 .github/ISSUE_TEMPLATE/request-a-feature-or-improvement.md delete mode 100644 .github/ISSUE_TEMPLATE/request-a-new-port.md delete mode 100644 .github/ISSUE_TEMPLATE/request-an-update-to-an-existing-port.md diff --git a/.github/ISSUE_TEMPLATE/00-report-package-build-failure.yml b/.github/ISSUE_TEMPLATE/00-report-package-build-failure.yml new file mode 100644 index 0000000000..449da8bc80 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/00-report-package-build-failure.yml @@ -0,0 +1,47 @@ +name: Report package build failure +description: Let us know about build failures in ports. +title: "[] build failure" +labels: ["category:port-bug"] +body: + - type: markdown + attributes: + value: | + ⚠ Please use the generated issue template instead to report a port build failure. ⚠
+ See [here](https://github.com/microsoft/vcpkg/issues/30604) how to properly report an issue with the latest vcpkg version: + + - type: input + id: os + attributes: + label: Operating system + placeholder: "e.g. Windows/Linux etc..." + validations: + required: true + - type: input + id: compiler + attributes: + label: Compiler + placeholder: "GCC, Clang, MSVC, MinGW, ..." + validations: + required: false + - type: textarea + id: reproduce + attributes: + label: Steps to reproduce the behavior + placeholder: "`./vcpkg install xxxx`" + render: "Shell" + validations: + required: true + - type: textarea + id: logs + attributes: + label: Failure logs + description: The console output and all the logs metioned in the output + validations: + required: true + - type: textarea + id: context + attributes: + label: Additional context + description: Add any other context about the problem here, such as what you have already tried to resolve the issue. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/01-request-a-new-port.yml b/.github/ISSUE_TEMPLATE/01-request-a-new-port.yml new file mode 100644 index 0000000000..78299a7f76 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-request-a-new-port.yml @@ -0,0 +1,36 @@ +name: Request a new port +description: Request a new port/library that vcpkg should support +title: "[New Port Request] " +labels: ["category:new-port", "info:good-first-issue"] + +body: + - type: input + id: name + attributes: + label: Library name + validations: + required: true + - type: input + id: description + attributes: + label: Library description + validations: + required: false + - type: input + id: url + attributes: + label: Source repository URL + validations: + required: true + - type: input + id: homepage + attributes: + label: Project homepage (if different from the source repository) + validations: + required: false + - type: textarea + id: additional-info + attributes: + label: Anything else that is useful to know when adding (such as optional features the library may have that should be included) + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/02-request-an-update-to-an-existing-port.yml b/.github/ISSUE_TEMPLATE/02-request-an-update-to-an-existing-port.yml new file mode 100644 index 0000000000..06ef6eee21 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02-request-an-update-to-an-existing-port.yml @@ -0,0 +1,23 @@ +name: Request an update to an existing port +description: Let us know about a new version of a library we should pick up. +title: "[] update to " +labels: ['category:port-update'] +body: + - type: input + id: name + attributes: + label: Library name + validations: + required: true + - type: input + id: version + attributes: + label: New version number + validations: + required: true + - type: textarea + id: information + attributes: + label: Other information that may be useful (release notes, etc...) + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/03-request-a-feature-or-improvement-to-a-port.yml b/.github/ISSUE_TEMPLATE/03-request-a-feature-or-improvement-to-a-port.yml new file mode 100644 index 0000000000..62c3765aed --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03-request-a-feature-or-improvement-to-a-port.yml @@ -0,0 +1,29 @@ +name: Request a feature or improvement to a port +description: Suggest an improvement to one the the ports/libraries in vcpkg +title: "[] " +labels: ["category:port-feature"] +body: + - type: textarea + attributes: + label: Is your feature request related to a problem? Please describe. + placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + validations: + required: true + - type: textarea + attributes: + label: Proposed solution + placeholder: A clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + attributes: + label: Describe alternatives you've considered + placeholder: A clear and concise description of any alternative solutions or features you've considered if applicable. + validations: + required: false + - type: textarea + attributes: + label: Additional context + placeholder: Add any other context or screenshots about the feature request here. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/04-request-a-feature-or-improvement.yml b/.github/ISSUE_TEMPLATE/04-request-a-feature-or-improvement.yml new file mode 100644 index 0000000000..1831952c83 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/04-request-a-feature-or-improvement.yml @@ -0,0 +1,29 @@ +name: Request a feature or improvement +description: Suggest an improvement to vcpkg +title: '' +labels: ["category:vcpkg-feature"] +body: + - type: textarea + attributes: + label: Is your feature request related to a problem? Please describe. + placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + validations: + required: true + - type: textarea + attributes: + label: Proposed solution + placeholder: A clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + attributes: + label: Describe alternatives you've considered + placeholder: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: false + - type: textarea + attributes: + label: Additional context + placeholder: Add any other context or screenshots about the feature request here. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/other-type-of-bug-report.md b/.github/ISSUE_TEMPLATE/05-other-type-of-bug-report.md similarity index 100% rename from .github/ISSUE_TEMPLATE/other-type-of-bug-report.md rename to .github/ISSUE_TEMPLATE/05-other-type-of-bug-report.md diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..ffa53d8351 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: I have a question + url: https://github.com/microsoft/vcpkg/discussions + about: Please ask and answer questions here. diff --git a/.github/ISSUE_TEMPLATE/i-have-a-question.md b/.github/ISSUE_TEMPLATE/i-have-a-question.md deleted file mode 100644 index 643d43dce9..0000000000 --- a/.github/ISSUE_TEMPLATE/i-have-a-question.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: I have a question -about: I have a question and don't see a clear answer in documentation -title: How do I ... -labels: Question -assignees: '' - ---- - -Please create a discussion in https://github.com/microsoft/vcpkg/discussions/new instead. diff --git a/.github/ISSUE_TEMPLATE/report-package-build-failure.md b/.github/ISSUE_TEMPLATE/report-package-build-failure.md deleted file mode 100644 index 5f0199cab1..0000000000 --- a/.github/ISSUE_TEMPLATE/report-package-build-failure.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -name: Report package build failure -about: Let us know about build failures in ports. -title: "[] build failure" -labels: category:port-bug -assignees: '' - ---- - - - - -**Host Environment** - -- OS: [e.g. Windows/Linux etc...] -- Compiler: revision - -**To Reproduce** - -Steps to reproduce the behavior: - -`./vcpkg install xxxx` - -**Failure logs** - -- Cut and paste the appropriate build messages from the console output. -- Attach ***every failure log file*** mentioned in the console output. - - - -**Additional context** - -Add any other context about the problem here, such as what you have already tried to resolve the issue. diff --git a/.github/ISSUE_TEMPLATE/request-a-feature-or-improvement-to-a-port.md b/.github/ISSUE_TEMPLATE/request-a-feature-or-improvement-to-a-port.md deleted file mode 100644 index a40036f953..0000000000 --- a/.github/ISSUE_TEMPLATE/request-a-feature-or-improvement-to-a-port.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -name: Request a feature or improvement to a port -about: Suggest an improvement to one the the ports/libraries in vcpkg -title: "[] " -labels: port feature -assignees: '' - ---- - -**** - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Proposed solution** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered if applicable. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/request-a-feature-or-improvement.md b/.github/ISSUE_TEMPLATE/request-a-feature-or-improvement.md deleted file mode 100644 index 55d06b16a6..0000000000 --- a/.github/ISSUE_TEMPLATE/request-a-feature-or-improvement.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -name: Request a feature or improvement -about: Suggest an improvement to vcpkg -title: '' -labels: vcpkg feature -assignees: '' - ---- - -**** - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Proposed solution** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/request-a-new-port.md b/.github/ISSUE_TEMPLATE/request-a-new-port.md deleted file mode 100644 index f8ac0d0aa7..0000000000 --- a/.github/ISSUE_TEMPLATE/request-a-new-port.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -name: Request a new port -about: Request a new port/library that vcpkg should support -title: "[New Port Request] " -labels: "category:new-port,info:good-first-issue" -assignees: '' - ---- - -Library name: - -Library description: - -Source repository URL: - -Project homepage (if different from the source repository): - -Anything else that is useful to know when adding (such as optional features the library may have that should be included): diff --git a/.github/ISSUE_TEMPLATE/request-an-update-to-an-existing-port.md b/.github/ISSUE_TEMPLATE/request-an-update-to-an-existing-port.md deleted file mode 100644 index 326d6a66ca..0000000000 --- a/.github/ISSUE_TEMPLATE/request-an-update-to-an-existing-port.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -name: Request an update to an existing port -about: Let us know about a new version of a library we should pick up. -title: "[] update to " -labels: 'category:port-update' -assignees: '' - ---- - -Library name: - -New version number: - -Other information that may be useful (release notes, etc...)