Skip to content

Commit c77e6a7

Browse files
committed
Add issue template readme contributing
1 parent 7a42772 commit c77e6a7

File tree

5 files changed

+130
-7
lines changed

5 files changed

+130
-7
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
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 be amazing. We are nothing without people like you helping build a better community 💐!
9+
- type: checkboxes
10+
id: checks
11+
attributes:
12+
label: Checklist
13+
description: Please confirm and check all the following options.
14+
options:
15+
- label: I added a descriptive title
16+
required: true
17+
- label: I searched for other issues and couldn't find a solution or duplication
18+
required: true
19+
- type: textarea
20+
id: what-happened
21+
attributes:
22+
label: What happened?
23+
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
24+
placeholder: Tell us what you see!
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: context
29+
attributes:
30+
label: Additional Context
31+
description: Add any additional context information or screenshots you think are useful.
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
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 be amazing. We are nothing without people like you helping build a better community 💐!
9+
10+
Lets make sure you are in the right place! If you have an idea/request for PyScript Core(the software, not the community aspect of it) please head over to the [core repository](https://github.com/pyscript/pyscript).
11+
12+
- type: checkboxes
13+
id: checks
14+
attributes:
15+
label: Checklist
16+
description: Please confirm and check all the following options
17+
options:
18+
- label: I added a descriptive title
19+
required: true
20+
- label: I searched for other feature requests and couldn't find a duplicate (including also the ``type-feature`` tag)
21+
required: true
22+
- label: I confirmed that it's not related to another project area (see the above section)
23+
required: true
24+
- type: textarea
25+
id: request-idea
26+
attributes:
27+
label: What is the idea?
28+
description: Describe what the feature is and the desired state
29+
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
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: why
34+
attributes:
35+
label: Why is this needed
36+
description: |
37+
Who would benefit from this and why would this add value to them? What problem does this solve?
38+
placeholder: This would benefit users who would like to see what is being used so they can learn and debug faster
39+
- type: textarea
40+
id: what
41+
attributes:
42+
label: What should happen?
43+
description: |
44+
What should be the user experience with the feature? Describe from a user perpective what they would do and see
45+
placeholder: A user would type in ``PyScript debug`` in the browser console and see a list of all variables created.
46+
- type: textarea
47+
id: context
48+
attributes:
49+
label: Additional Context
50+
description: |
51+
Is there any other information that you think would be valuable for the team to know?

.github/ISSUE_TEMPLATE/misc.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
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 be amazing. We are nothing without people like you helping build a better community 💐!
9+
10+
- type: checkboxes
11+
id: checks
12+
attributes:
13+
label: Checklist
14+
description: Please confirm and check all the following options.
15+
options:
16+
- label: I added a descriptive title
17+
required: true
18+
- label: I searched for other issues and couldn't find a duplication
19+
required: true
20+
- type: textarea
21+
id: what
22+
attributes:
23+
label: What is the issue/comment/problem?
24+
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.
25+
validations:
26+
required: true

CONTRIBUTING.MD

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Contributing to PyScript
2+
3+
Thank you for taking the time to contribute to the PyScript Collective!
4+
5+
This file will guide you through how to make your first community contribution, if you're looking for contributing to PyScript Core, please head over to [this](https://github.com/pyscript/pyscript) repository.
6+
7+
The intention set for this repository is for it to be a place that's built by the community to serve the community. We want contributors to take ownership on tasks like onboarding new folks, co-maintaining examples and keeping them and enriching this repository with their own perspectives. It's a space for users and contributors to discuss on how the community should be shaped.
8+
9+
### Table of contents:
10+
11+
**[Contributing a new example](Contributing-a-new-example)**
12+
**[Reporting a bug](Reporting-a-bug)**
13+
**[Opening an enhancement issue](Opening-an-enhancement-issue)**
14+
15+
### Contributing a new example
16+
17+
### Reporting a bug
18+
19+
### Opening an enhancement issue

README.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,9 @@
1-
# Awesome Pyscript
1+
# PyScript Collective
22

33
A list of community contributed content that enriches PyScript's ecosystem.
44

5-
Learn [how to contribute](CONTRIBUTING.MD) to this repository.
5+
We strive to make people feel valued and valuable and we hope to make lots of iterations with the help of the community to build a place that's inclusive and uplifiting to all. Please check our [code of conduct](https://github.com/pyscript/governance/blob/main/CODE-OF-CONDUCT.md). If you're interested in contributing head over to our [how to contribute](CONTRIBUTING.MD) document.
66

77
## Index
88

9-
- Examples
10-
11-
- Video tutorials
12-
13-
- Articles
9+
[Examples]()

0 commit comments

Comments
 (0)