mirror of https://github.com/CrimsonTome/tldr.git
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 <kbdharunkrishna@gmail.com> * page-request-template: minor fix Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> * cleanup: remove required false parameter Co-authored-by: Lena <126529524+acuteenvy@users.noreply.github.com> --------- Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>pull/23/head
parent
b65bc23fac
commit
95e3f55e07
|
@ -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
|
|
@ -1,6 +1,6 @@
|
||||||
name: 📄 Page modification request
|
name: 📄 Page modification request
|
||||||
title: "page modification request: "
|
title: "Page modification request: "
|
||||||
description: Page modification request template.
|
description: Request modification of a page.
|
||||||
labels: page edit, help wanted
|
labels: page edit, help wanted
|
||||||
body:
|
body:
|
||||||
- type: textarea
|
- type: textarea
|
||||||
|
@ -8,18 +8,35 @@ body:
|
||||||
label: Command description
|
label: Command description
|
||||||
description: Describe the command you want the page(s) to be modified.
|
description: Describe the command you want the page(s) to be modified.
|
||||||
placeholder: Tell us about the changes in the command!
|
placeholder: Tell us about the changes in the command!
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
- type: input
|
- type: input
|
||||||
attributes:
|
attributes:
|
||||||
label: Command details
|
label: Command details
|
||||||
description: Describe any details related to a command.
|
description: Describe any details related to a command.
|
||||||
placeholder: e.g. command version
|
placeholder: e.g. command version
|
||||||
- type: checkboxes
|
- type: input
|
||||||
attributes:
|
attributes:
|
||||||
label: OS
|
label: Documentation
|
||||||
description: Select which operating system(s) this command works with.
|
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:
|
options:
|
||||||
- label: Android
|
- Android
|
||||||
- label: Linux
|
- Common
|
||||||
- label: macOS (osx)
|
- FreeBSD
|
||||||
- label: sunOS
|
- Linux
|
||||||
- label: Windows
|
- 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.
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
name: 📄 Page request
|
name: 📄 Page request
|
||||||
title: "page request: "
|
title: "Page request: "
|
||||||
description: Page request template.
|
description: Request creation of a page.
|
||||||
labels: new command, help wanted
|
labels: new command, help wanted
|
||||||
body:
|
body:
|
||||||
- type: textarea
|
- type: textarea
|
||||||
|
@ -8,19 +8,35 @@ body:
|
||||||
label: Command description
|
label: Command description
|
||||||
description: Describe a command you want to be summarized.
|
description: Describe a command you want to be summarized.
|
||||||
placeholder: Tell us about the command!
|
placeholder: Tell us about the command!
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
- type: input
|
- type: input
|
||||||
attributes:
|
attributes:
|
||||||
label: Command details
|
label: Command details
|
||||||
description: Describe any details related to a command.
|
description: Describe any details related to a command.
|
||||||
placeholder: e.g. command version
|
placeholder: e.g. command version
|
||||||
- type: checkboxes
|
- type: input
|
||||||
attributes:
|
attributes:
|
||||||
label: OS
|
label: Documentation
|
||||||
description: Select which operating system(s) this command works with.
|
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:
|
options:
|
||||||
- label: Android
|
- Android
|
||||||
- label: Linux
|
- Common
|
||||||
- label: macOS (osx)
|
- FreeBSD
|
||||||
- label: sunOS
|
- Linux
|
||||||
- label: Windows
|
- 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.
|
||||||
|
|
|
@ -1,40 +1,12 @@
|
||||||
name: 📄 Page translation request
|
name: 📄 Page translation request
|
||||||
title: "page translation: "
|
title: "Page translation request: "
|
||||||
description: Page translation request template.
|
description: Request translation of a page.
|
||||||
labels: translation
|
labels: translation, help wanted
|
||||||
body:
|
body:
|
||||||
- type: textarea
|
- type: textarea
|
||||||
attributes:
|
attributes:
|
||||||
label: Command description
|
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!
|
placeholder: Tell us what TLDR page you want to see in your language!
|
||||||
validations:
|
validations:
|
||||||
required: true
|
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
|
|
||||||
|
|
Loading…
Reference in New Issue