Skip to content

Add info on how to make docs for examples #16

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
Jul 5, 2022
Merged
Changes from all commits
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
25 changes: 17 additions & 8 deletions CONTRIBUTING.MD
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,25 @@ The intention set for this repository is for it to be a place that's built by th

## 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](#recommended-guidelines-for-a-resource)**
- **[Reporting a bug](#reporting-a-bug)**
- **[Opening an enhancement issue](#opening-an-enhancement-issue)**

- **[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:
Here are some great general examples of what a good contribution might be(not restrict:

- 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
Expand All @@ -33,6 +37,11 @@ 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)

Adding docs:

PyScript strives to be accessible to beginners, if you're writing code that might be confusing please add comments explaining your choices.
If you need to write further docs for your program feel free to create a `README.md` file with instructions about installation, use and other details on how to run your example.

#### Running the 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/).
Expand Down