-
Notifications
You must be signed in to change notification settings - Fork 71
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
- Loading branch information
1 parent
4c3a34d
commit e146728
Showing
3 changed files
with
111 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,63 @@ | ||
name: Report a problem 🐛 | ||
description: Problem reports are for when something behaves incorrectly, or differently from how you'd expect. | ||
labels: [bug] | ||
body: | ||
- type: textarea | ||
id: describe | ||
attributes: | ||
label: Describe the bug | ||
description: | | ||
Provide a short description (one or two sentences) about the problem. What did you expect to happen, and what is actually happening? | ||
If possible, provide screenshots or error messages that you've encountered. | ||
value: | | ||
**context** | ||
When I do ___. | ||
**expectation** | ||
I expected ___ to occur. | ||
**bug** | ||
But instead ___ happens | ||
Here's an error message I ran into... | ||
**problem** | ||
This is a problem for people doing ___ because ___. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: reproduce | ||
attributes: | ||
label: Reproduce the bug | ||
description: | | ||
Provide information that others may use to re-produce this behavior. | ||
For example: | ||
- Step-by-step instructions that others can follow. | ||
- Links to a website that demonstrates the bug. | ||
- Information about certain conditions that the bug pops up. | ||
placeholder: | | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: environment | ||
attributes: | ||
label: List your environment | ||
description: | | ||
List the environment needed to reproduce the error. | ||
Here are a few ideas: | ||
- Version of markdown-it-py | ||
- Versions of mdit-py-plugins | ||
- The version of Python you're using. | ||
- Your operating system | ||
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,4 @@ | ||
contact_links: | ||
- name: Questions or general discussion ❓🗣️ | ||
url: https://github.com/executablebooks/markdown-it-py/discussions | ||
about: Use Disussions for general conversations that aren't meant for actionable Issues. |
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,44 @@ | ||
name: Request an enhancement 💡 | ||
description: Suggest an idea for this project | ||
labels: [enhancement] | ||
body: | ||
|
||
- type: textarea | ||
id: context | ||
attributes: | ||
label: Context | ||
description: | | ||
- Provide background to help others understand this issue. | ||
- Describe the problem or need you'd like to address. | ||
validations: | ||
required: true | ||
|
||
|
||
- type: textarea | ||
id: proposal | ||
attributes: | ||
label: Proposal | ||
description: | | ||
- A simple and clear description of what you're proposing. | ||
- Ideas or constraints for how to implement this proposal | ||
- Important considerations to think about or discuss | ||
validations: | ||
required: false | ||
|
||
|
||
- type: textarea | ||
id: tasks | ||
attributes: | ||
label: Tasks and updates | ||
description: | | ||
Use this area to track ongoing work and to-do items. | ||
The more specific the better. | ||
_If you can't think of anything then just leave this blank and we can fill it in later! This can be filled in as we understand more about an issue._ | ||
placeholder: | | ||
- [ ] Discuss and decide on what to do... | ||
- [ ] Implement partial feature A... | ||
validations: | ||
required: false |