From 95e3f55e073ed993c64b1a2f2f8c18ac91822abd Mon Sep 17 00:00:00 2001 From: Lena <126529524+acuteenvy@users.noreply.github.com> Date: Sun, 29 Oct 2023 16:38:08 +0100 Subject: [PATCH] ISSUE-TEMPLATES: add Let's document; update others (#11326) * ISSUE-TEMPLATES: add Let's document; update others * cleanup: update Issue templates Signed-off-by: K.B.Dharun Krishna * page-request-template: minor fix Signed-off-by: K.B.Dharun Krishna * cleanup: remove required false parameter Co-authored-by: Lena <126529524+acuteenvy@users.noreply.github.com> --------- Signed-off-by: K.B.Dharun Krishna Co-authored-by: K.B.Dharun Krishna --- .github/ISSUE_TEMPLATE/lets-document.yml | 46 +++++++++++++++++++ .../page-modification-request.yml | 37 +++++++++++---- .github/ISSUE_TEMPLATE/page-request.yml | 38 ++++++++++----- .github/ISSUE_TEMPLATE/page-translation.yml | 36 ++------------- 4 files changed, 104 insertions(+), 53 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/lets-document.yml diff --git a/.github/ISSUE_TEMPLATE/lets-document.yml b/.github/ISSUE_TEMPLATE/lets-document.yml new file mode 100644 index 000000000..19ae5d01d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/lets-document.yml @@ -0,0 +1,46 @@ +name: 📄 Let's document +title: "Let's document: " +description: Request creation of multiple related pages (e.g. a utility with multiple subcommands). +labels: new command, help wanted, let's document +body: + - type: textarea + attributes: + label: Command description + description: Describe the commands you want to create. + placeholder: Tell us about the commands! + validations: + required: true + - type: input + attributes: + label: Documentation + description: Link to the official documentation. + placeholder: https://example.com + - type: dropdown + attributes: + label: Platform + description: What platform does the program run on? (Select "Common" if the program works on more than one platform) + options: + - Android + - Common + - FreeBSD + - Linux + - macOS (OS X) + - NetBSD + - OpenBSD + - SunOS + - Windows + validations: + required: true + - type: textarea + attributes: + label: Additional information + description: Provide additional information if the command differs between platforms. + - type: textarea + attributes: + label: Commands + description: List out all the pages you want to create. + placeholder: | + - [] command1 + - [] command2 + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/page-modification-request.yml b/.github/ISSUE_TEMPLATE/page-modification-request.yml index 1767f5a0b..2c4cf7420 100644 --- a/.github/ISSUE_TEMPLATE/page-modification-request.yml +++ b/.github/ISSUE_TEMPLATE/page-modification-request.yml @@ -1,6 +1,6 @@ name: 📄 Page modification request -title: "page modification request: " -description: Page modification request template. +title: "Page modification request: " +description: Request modification of a page. labels: page edit, help wanted body: - type: textarea @@ -8,18 +8,35 @@ body: label: Command description description: Describe the command you want the page(s) to be modified. placeholder: Tell us about the changes in the command! + validations: + required: true - type: input attributes: label: Command details description: Describe any details related to a command. placeholder: e.g. command version - - type: checkboxes + - type: input attributes: - label: OS - description: Select which operating system(s) this command works with. + label: Documentation + description: Link to the official documentation. + placeholder: https://example.com + - type: dropdown + attributes: + label: Platform + description: What platform does the program run on? (Select "Common" if the program works on more than one platform) options: - - label: Android - - label: Linux - - label: macOS (osx) - - label: sunOS - - label: Windows + - Android + - Common + - FreeBSD + - Linux + - macOS (OS X) + - NetBSD + - OpenBSD + - SunOS + - Windows + validations: + required: true + - type: textarea + attributes: + label: Additional information + description: Provide additional information if the command differs between platforms. diff --git a/.github/ISSUE_TEMPLATE/page-request.yml b/.github/ISSUE_TEMPLATE/page-request.yml index 40941294c..2e8f7ccad 100644 --- a/.github/ISSUE_TEMPLATE/page-request.yml +++ b/.github/ISSUE_TEMPLATE/page-request.yml @@ -1,6 +1,6 @@ name: 📄 Page request -title: "page request: " -description: Page request template. +title: "Page request: " +description: Request creation of a page. labels: new command, help wanted body: - type: textarea @@ -8,19 +8,35 @@ body: label: Command description description: Describe a command you want to be summarized. placeholder: Tell us about the command! + validations: + required: true - type: input attributes: label: Command details description: Describe any details related to a command. placeholder: e.g. command version - - type: checkboxes + - type: input attributes: - label: OS - description: Select which operating system(s) this command works with. + label: Documentation + description: Link to the official documentation. + placeholder: https://example.com + - type: dropdown + attributes: + label: Platform + description: What platform does the program run on? (Select "Common" if the program works on more than one platform) options: - - label: Android - - label: Linux - - label: macOS (osx) - - label: sunOS - - label: Windows - + - Android + - Common + - FreeBSD + - Linux + - macOS (OS X) + - NetBSD + - OpenBSD + - SunOS + - Windows + validations: + required: true + - type: textarea + attributes: + label: Additional information + description: Provide additional information if the command differs between platforms. diff --git a/.github/ISSUE_TEMPLATE/page-translation.yml b/.github/ISSUE_TEMPLATE/page-translation.yml index 4d7bba0c2..19bf7f6ad 100644 --- a/.github/ISSUE_TEMPLATE/page-translation.yml +++ b/.github/ISSUE_TEMPLATE/page-translation.yml @@ -1,40 +1,12 @@ name: 📄 Page translation request -title: "page translation: " -description: Page translation request template. -labels: translation +title: "Page translation request: " +description: Request translation of a page. +labels: translation, help wanted body: - type: textarea attributes: label: Command description - description: Describe a command you want to be translated. + description: Describe the command to get translated for your language. placeholder: Tell us what TLDR page you want to see in your language! validations: required: true - - type: input - attributes: - label: Command details - description: Describe any details related to a command. - placeholder: e.g. command version - - type: dropdown - attributes: - label: OS - description: Select an operating system category which this command falls into. - multiple: false - options: - - Linux - - Android - - macOS - - Windows - - General - - Other - validations: - required: true - - type: input - attributes: - label: OS details - description: Describe any details related to an operating system. - placeholder: | - e.g. OS version obtained via: - `uname -a` for Linux - `sw_vers` for macOS - `ver` for Windows