Skip to content

Address CONTRIBUTING.md file of #4 #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 27, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Bug Report
description: Create a report to help us improve
labels: ["type: bug", "needs-triage"]
body:
- type: markdown
attributes:
value: |
Thanks for helping PyScript be amazing. We are nothing without people like you helping build a better community 💐!
- type: checkboxes
id: checks
attributes:
label: Checklist
description: Please confirm and check all the following options.
options:
- label: I added a descriptive title
required: true
- label: I searched for other issues and couldn't find a solution or duplication
required: true
- type: textarea
id: what-happened
attributes:
label: What happened?
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
placeholder: Tell us what you see!
validations:
required: true
- type: textarea
id: context
attributes:
label: Additional Context
description: Add any additional context information or screenshots you think are useful.
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: Feature Request
description: Create a feature request to make PyScript even better
labels: ["type: enhancement", "needs-triage"]
body:
- type: markdown
attributes:
value: |
Thanks for helping PyScript be amazing. We are nothing without people like you helping build a better community 💐!

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).

- type: checkboxes
id: checks
attributes:
label: Checklist
description: Please confirm and check all the following options
options:
- label: I added a descriptive title
required: true
- label: I searched for other feature requests and couldn't find a duplicate (including also the ``type-feature`` tag)
required: true
- label: I confirmed that it's not related to another project area (see the above section)
required: true
- type: textarea
id: request-idea
attributes:
label: What is the idea?
description: Describe what the feature is and the desired state
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
validations:
required: true
- type: textarea
id: why
attributes:
label: Why is this needed
description: |
Who would benefit from this and why would this add value to them? What problem does this solve?
placeholder: This would benefit users who would like to see what is being used so they can learn and debug faster
- type: textarea
id: what
attributes:
label: What should happen?
description: |
What should be the user experience with the feature? Describe from a user perpective what they would do and see
placeholder: A user would type in ``PyScript debug`` in the browser console and see a list of all variables created.
- type: textarea
id: context
attributes:
label: Additional Context
description: |
Is there any other information that you think would be valuable for the team to know?
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/misc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Miscellaneous
description: For issues that don't belong in other categories
labels: ["type: misc", "needs-triage"]
body:
- type: markdown
attributes:
value: |
Thanks for helping PyScript be amazing. We are nothing without people like you helping build a better community 💐!

- type: checkboxes
id: checks
attributes:
label: Checklist
description: Please confirm and check all the following options.
options:
- label: I added a descriptive title
required: true
- label: I searched for other issues and couldn't find a duplication
required: true
- type: textarea
id: what
attributes:
label: What is the issue/comment/problem?
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.
validations:
required: true
19 changes: 19 additions & 0 deletions CONTRIBUTING.MD
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Contributing to PyScript

Thank you for taking the time to contribute to the PyScript Collective!

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.

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.

### Table of contents:

**[Contributing a new example](Contributing-a-new-example)**
**[Reporting a bug](Reporting-a-bug)**
**[Opening an enhancement issue](Opening-an-enhancement-issue)**

### Contributing a new example

### Reporting a bug

### Opening an enhancement issue
10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@
# Awesome Pyscript
# PyScript Collective

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

Learn [how to contribute](CONTRIBUTING.MD) to this repository.
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.

## Index

- Examples

- Video tutorials

- Articles
[Examples]()

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Video tutorials
  • Articles

being removed? Won't it be nice to point beginners to useful articles and videos?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @thenithinbalaji thanks for the comment :)
I'm trying to find what's the best way of showcasing this, tbh.
Since we didn't have any examples for that I decided to remove.
The fact is the repository is not ready yet 😅
I opened it to the public so a colleague could work on it too.
Once I merge this PR that's currently a WIP the repo will be ready to receive contributions and then I'll be really happy to receive a contribution from you! if you have any inputs on how to display this info :)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh fine np