-
Notifications
You must be signed in to change notification settings - Fork 3.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add docs issue templates (#4321)
- Loading branch information
Showing
2 changed files
with
74 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| name: 📄 CLI Docs Enhancement | ||
| description: File a potential enhancement for the npm documentation | ||
| title: "[DOCS] <title>" | ||
| labels: [Documentation, Needs Triage] | ||
| body: | ||
| - type: checkboxes | ||
| attributes: | ||
| label: Is there an existing issue for this? | ||
| description: Please [search here](https://github.com/npm/cli/issues) to see if an issue already exists for your problem. | ||
| options: | ||
| - label: I have searched the existing issues | ||
| required: true | ||
| - type: checkboxes | ||
| attributes: | ||
| label: This is a CLI Docs Enhancement, not another kind of Docs Enhancement. | ||
| description: These issue templates are only for CLI documentation enhancements. If you are looking to submit another kind of documentation enhancement, please submit it to the [documentation](https://github.com/npm/documentation) repo. | ||
| options: | ||
| - label: This is a CLI Docs Enhancement. | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Description of Problem | ||
| description: A clear & concise description of the current state of the docs. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Potential Solution | ||
| description: A clear & concise description of the potential enhancement, if there is one. | ||
| validations: | ||
| required: false | ||
| - type: input | ||
| attributes: | ||
| label: Docs URL | ||
| description: Please provide the URL of the page you'd like to see an enhancement to. | ||
| validations: | ||
| required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| name: 📄 CLI Docs Problem | ||
| description: File a problem with the npm documentation | ||
| title: "[DOCS] <title>" | ||
| labels: [Documentation, Needs Triage] | ||
| body: | ||
| - type: checkboxes | ||
| attributes: | ||
| label: Is there an existing issue for this? | ||
| description: Please [search here](https://github.com/npm/cli/issues) to see if an issue already exists for your problem. | ||
| options: | ||
| - label: I have searched the existing issues | ||
| required: true | ||
| - type: checkboxes | ||
| attributes: | ||
| label: This is a CLI Docs Problem, not another kind of Docs Problem. | ||
| description: These issue templates are only for CLI documentation problems. If you are looking to submit another kind of documentation problem, please submit it to the [documentation](https://github.com/npm/documentation) repo. | ||
| options: | ||
| - label: This is a CLI Docs Problem. | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Description of Problem | ||
| description: A clear & concise description of what is wrong with the docs. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Potential Solution | ||
| description: A clear & concise description of a potential solution or fix to the problem, if there is one. | ||
| validations: | ||
| required: false | ||
| - type: input | ||
| attributes: | ||
| label: Affected URL | ||
| description: Please provide the affected URL. | ||
| validations: | ||
| required: false |