-
Notifications
You must be signed in to change notification settings - Fork 14
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
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,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. |
This file contains hidden or 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,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? |
This file contains hidden or 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,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 |
This file contains hidden or 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,58 @@ | ||
# 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 to contribute 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 of tasks like onboarding new folks, co-maintaining examples and supporting them, and enriching this repository with their own perspectives. It's a space for users and contributors to discuss how the community should be shaped. | ||
|
||
### Table of contents: | ||
|
||
**[Contributing a new example](Contributing-a-new-example)** | ||
**[Recommended guidelines for an example](Recommended-guidelines-for-an-example)** | ||
**[Running the tests](Running-the-tests)** | ||
**[Contributing a new resource](Contributing-a-new-resource)** | ||
**Recommended guidelines for a resource** | ||
**[Reporting a bug](Reporting-a-bug)** | ||
**[Opening an enhancement issue](Opening-an-enhancement-issue)** | ||
|
||
### Contributing a new example | ||
|
||
We try not to have strong boundaries in what kinds of contributions are accepted in this repository as we want contributors to be able to be as creative as they can. Still, we do have some recommendations in place so the examples in this repository offer a consistent experience to the users. | ||
|
||
#### Recommended guidelines for an example | ||
|
||
Here are some great examples of contributions: | ||
|
||
- it showcases PyScript power to leverage other tools (either from the JavaScript or the Python ecosystem) | ||
- it expands on the PyScript documentation, making the use of PyScript clearer to users | ||
- it offers engaging educational material | ||
|
||
Adding meta-data: | ||
|
||
- adding tags to your example will help us organize this repository in a much more meaningful way. Example tags come at the beginning of your main `HTML` file in the form of a comment. See the [example](examples/hello_world.html) | ||
- you're also welcome to add your email or name or other forms of contact information in the header at the beginning of the file. See the [example](examples/hello_world.html) | ||
|
||
#### Running tests | ||
|
||
To run the tests it's necessary to have a local build of PyScript running, you can learn more about it in the [PyScript docs](https://docs.pyscript.net/latest/). | ||
|
||
Run `make test` on the root repository to run the tests locally. | ||
|
||
Remember to have the right path set up for your `css` and `script` tags. They should point to your local build instead of PyScript's self-hosted version. | ||
|
||
### Contributing a new resource | ||
|
||
The PyScript Collective also welcomes contributions like blog posts, videos, video tutorials, podcasts, and all of the amazing things our community is putting out there. | ||
|
||
The contributions in this topic are more similar to what an `awesome-page` would look like. If you want to add a new kind of contribution that wasn't laid out on the [README](README.md) yet, feel free to do so. | ||
|
||
### Reporting a bug | ||
|
||
You can contribute a bug you found on the tests, examples, or any other technical part of the infrastructure of this repository. | ||
Please follow the guidelines on the Issue template. | ||
|
||
### Opening an enhancement issue | ||
|
||
Would you like to propose an enhancement to this repository, feel free to open an enhancement proposal issue. Please follow the guidelines on the Issue template. | ||
|
This file contains hidden or 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,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]() | ||
This file contains hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
being removed? Won't it be nice to point beginners to useful articles and videos?
There was a problem hiding this comment.
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 :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oh fine np