-
Notifications
You must be signed in to change notification settings - Fork 97
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve pull request and issue templates (#633)
- Loading branch information
1 parent
3025b89
commit 8636fc6
Showing
4 changed files
with
27 additions
and
49 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,5 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: Project Chat | ||
url: https://asciidoctor.zulipchat.com/ | ||
about: Please ask for help, share feedback, or exchange ideas in the project chat |
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 |
---|---|---|
@@ -1,26 +1,11 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: 'enhancement, discussion' | ||
assignees: '' | ||
|
||
name: Feature Request | ||
about: Suggest a formal proposal for an enhancement | ||
labels: '✨ enhancement, 💬 discussion' | ||
--- | ||
|
||
This is an example issue. You are free to change the headings and text. | ||
|
||
## 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 [...] | ||
|
||
## Describe the solution you'd like | ||
|
||
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 | ||
Please provide details about: | ||
|
||
Add any other context or screenshots about the feature request here. | ||
* What you're trying to do | ||
* Why you can't use this extension for this | ||
* How you think this extension could handle this |
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 |
---|---|---|
@@ -1,34 +1,17 @@ | ||
--- | ||
name: Report a problem | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
name: Bug Report | ||
about: If something isn't working the way you expect it to | ||
labels: '🐞 bug' | ||
--- | ||
|
||
This is an example issue. Use just the headings and fill out all necessary information. Screenshots & Files and Additional Context are optional. | ||
|
||
## Description | ||
|
||
A clear and concise description of what the issue is. | ||
|
||
## System Information | ||
|
||
You can find the VSCode and OS information under Help -> About. To check the extension information go to the extension browser (CTRL+SHIFT+X, Mac CMD+SHIFT+X). | ||
|
||
## To Reproduce | ||
|
||
Steps to reproduce the issue: | ||
|
||
1. Go to '...' | ||
2. Click on '....' | ||
3. Etc... | ||
Please provide details about: | ||
|
||
## Screenshots & Files | ||
* What you're trying to do | ||
* What happened | ||
* What you expected to happen | ||
|
||
If applicable, add screenshots to help explain your problem. If the problem occurs only in a specific file, attach the file to the issue (do not copy the contents here). | ||
Please share relevant sample content. Or better yet, provide a link to a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example). | ||
|
||
## Additional Context | ||
We'll also need your system information (get it under "Help" -> "About" in VS Code). Share the installed extension version (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>X</kbd> or <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>X</kbd> on macOS). | ||
|
||
Add any other context about the problem here. | ||
Provide steps to reproduce the issue and, if applicable, add screenshots to make it easier to understand. |
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,5 @@ | ||
**IMPORTANT: Please do not create a Pull Request without creating an issue first.** | ||
|
||
*Any change needs to be discussed before proceeding. Failure to do so may result in the rejection of the pull request.* | ||
|
||
Put `resolves #XXX` in your comment to auto-close the issue that your PR fixes. |