8000 Add issue forms (#264) · Siddharth-cmd/pyscript@5d733ab · GitHub
[go: up one dir, main page]
Skip to content

Commit 5d733ab

Browse files
LtDan33alago1pre-commit-ci[bot]barnwellfpliger
authored
Add issue forms (pyscript#264)
* Added bug report and feature request issue forms * Update bug-report.yml Added browsers dropdown to bugs * Added misc issue type * Add keypress event to todo example (pyscript#241) * add enter keypress event in todo example * fix linting * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * Changed variable names to snake_case for PEP8 formatting (pyscript#211) * Changed variable names to snakecase for PEP8 formatting. * Changed variable names to snakecase for PEP8 formatting. * fix indentation Co-authored-by: Fabio Pliger <fabio.pliger@gmail.com> * Add issue templates (pyscript#252) * add issue templates * incorporate @fpliger suggestions * Removed mardown files. Added link for questions * Updated browser dev console info * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Minor typo * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Fix issue with labels that should be strings, ignore pretty-format of ISSUE_TEMPLATE yaml files * Removed old md. Updated label * add the needs-triage label to all new issues Co-authored-by: Allan Lago <35788148+alago1@users.noreply.github.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Jason Barnwell <master.j1994@gmail.com> Co-authored-by: Fabio Pliger <fabio.pliger@gmail.com> Co-authored-by: Antonio Cuni <anto.cuni@gmail.com> Co-authored-by: Matt Kramer <mkramer@anaconda.com>
1 parent 1bf6cc0 commit 5d733ab

File tree

7 files changed

+173
-43
lines changed

7 files changed

+173
-43
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: Bug Report
2+
description: Create a report to help us improve
3+
labels: ["type: bug", "needs-triage"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for helping PyScript! 🐍
9+
10+
Going through bugs and issues takes up a lot of time, so please be so kind and take a few minutes to fill out all the areas to the best of your ability.
11+
12+
There will always be more issues than there is time to do them, and so we will need to selectively close issues that don't provide enough information, so we can focus our time on helping people like you who fill out the issue form completely. Thank you for your collaboration!
13+
14+
There are also already a lot of open issues, so please take 2 minutes and search through existing ones to see if what you are experiencing already exists
15+
16+
Thanks for helping PyScript be amazing. We are nothing without people like you helping build a better community 💐!
17+
- type: checkboxes
18+
id: checks
19+
attributes:
20+
label: Checklist
21+
description: Please confirm and check all the following options.
22+
options:
23+
- label: I added a descriptive title
24+
required: true
25+
- label: I searched for other issues and couldn't find a solution or duplication
26+
required: true
27+
- label: I already searched in Google and didn't find any good information or help
28+
required: true
29+
- type: textarea
30+
id: what-happened
31+
attributes:
32+
label: What happened?
33+
description: And what should have happened instead? This really helps everyone review quicker and greatly increases the chance that someone can get around to solve your issue
34+
placeholder: Tell us what you see!
35+
validations:
36+
required: true
37+
- type: dropdown
38+
id: browsers
39+
attributes:
40+
label: What browsers are you seeing the problem on? (if applicable)
41+
multiple: true
42+
options:
43+
- Firefox
44+
- Chrome
45+
- Safari
46+
- Microsoft Edge
47+
- Other
48+
validations:
49+
required: false
50+
- type: textarea
51+
id: list
52+
attributes:
53+
label: Console info
54+
description: |
55+
If there are errors in your browser console then its helpful to be able to troubleshoot.
56+
- Chrome , Firefox, and Edge: Right-click on the page and select *Inspect*. Alternatively you can press F12 on your keyboard.
57+
- Safari: Find instructions [here](https://support.apple.com/guide/safari/use-the-developer-tools-in-the-develop-menu-sfri20948/mac).
58+
render: shell
59+
- type: textarea
60+
id: context
61+
attributes:
62+
label: Additional Context
63+
description: Add any additional context information or screenshots you think are useful.

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 23 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Question
4+
url: https://community.anaconda.cloud/c/tech-topics/pyscript
5+
about: For questions or discussions about pyscript

‎.github/ISSUE_TEMPLATE/feature-request.yml

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
name: Feature Request
2+
description: Create a feature request to make PyScript even better
3+
labels: ["type: enhancement", "needs-triage"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
### Thanks for helping PyScript! 🐍
9+
10+
Going through feature requests and issues takes up a lot of time, so please be so kind and take a few minutes to fill out all the areas to the best of your ability.
11+
12+
There will always be more great ideas than there is time to do them, and so we will need to selectively close issues that don't provide enough information, so everyone can focus our time on helping people like you who fill out the form completely. Thank you for your collaboration!
13+
14+
There are also already a lot of open requests, so please take 2 minutes and search through existing ones to see if your idea already exists. If you find something close, please upvote that request and comment.
15+
16+
Thanks for helping PyScript be amazing. We are nothing without people like you helping build a better community 💐!
17+
18+
### Lets make sure you are in the right place. If you have an idea/request for:
19+
20+
- #### A specific package/library (such as pandas or scikit learn):
21+
22+
Search for that respective library on github repo or website. You will have much more success there.
23+
24+
- #### A general Python question/feature request:
25+
26+
Try out a forum post [here](https://discuss.python.org/c/users/7)
27+
28+
- type: checkboxes
29+
id: checks
30+
attributes:
31+
label: Checklist
32+
description: Please confirm and check all the following options
33+
options:
34+
- label: I added a descriptive title
35+
required: true
36+
- label: I searched for other feature requests and couldn't find a duplicate (including also the ``type-feature`` tag)
37+
required: true
38+
- label: I confirmed that it's not related to another project are area (see the above section)
39+
required: true
40+
- type: textarea
41+
id: request-idea
42+
attributes:
43+
label: What is the idea?
44+
description: Describe what the feature is and the desired state
45+
placeholder: This feature would allow any user of PyScript to type in a simple command in the console and show all variables currently in use
46+
validations:
47+
required: true
48+
- type: textarea
49+
id: why
50+
attributes:
51+
label: Why is this needed
52+
description: |
53+
Who would benefit from this and why would this add value to them? What problem does this solve?
54+
placeholder: This would benefit users who would like to see what is being used so they can learn and debug faster
55+
- type: textarea
56+
id: what
57+
attributes:
58+
label: What should happen?
59+
description: |
60+
What should be the user experience with the feature? Describe from a user perpective what they would do and see
61+
placeholder: A user would type in ``PyScript debug`` in the browser console and see a list of all variables created.
62+
- type: textarea
63+
id: context
64+
attributes:
65+
label: Additional Context
66+
description: |
67+
Is there any other information that you think would be valuable for the team to know?

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/misc.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Miscellaneous
2+
description: For issues that don't belong in other categories
3+
labels: ["type: misc", "needs-triage"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for helping PyScript! 🐍
9+
10+
This issue is for things that doesn't make sense to put into the other issue categories and we don't want it to get lost.
11+
12+
Going through issues takes up a lot of time, so please be so kind and take a few minutes to fill out all the areas to the best of your ability.
13+
14+
There will always be more issues than there is time to do them, and so we will need to selectively close issues that don't provide enough information, so we can focus our time on helping people like you who fill out the issue form completely. Thank you for your collaboration!
15+
16+
There are also already a lot of open issues, so please take 2 minutes and search through existing ones to see if what you are experiencing already exists
17+
18+
Thanks for helping PyScript be amazing. We are nothing without people like you helping build a better community 💐!
19+
- type: checkboxes
20+
id: checks
21+
attributes:
22+
label: Checklist
23+
description: Please confirm and check all the following options.
24+
options:
25+
- label: I added a descriptive title
26+
required: true
27+
- label: I searched for other issues and couldn't find a duplication
28+
required: true
29+
- label: I already searched in Google and didn't find any good information or help
30+
required: true
31+
- type: textarea
32+
id: what
33+
attributes:
34+
label: What is the issue/comment/problem?
35+
description: This is a miscellaneous issue so this could be just about anything. We simply ask that you provide as many details as you can to help spur discussion or the outcome you want.
36+
validations:
37+
required: true

‎.pre-commit-config.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ repos:
5555
hooks:
5656
- id: pretty-format-yaml
5757
args: [--autofix, --indent, '4']
58+
exclude: .github/ISSUE_TEMPLATE/.*\.yml$
5859

5960
- repo: https://github.com/asottile/pyupgrade
6061
rev: v2.32.1

0 commit comments

Comments
 (0)
0