From db2e8c9efe4c61ee86b2b174018d2e27f26d614d Mon Sep 17 00:00:00 2001 From: Mariana Meireles Date: Mon, 4 Jul 2022 21:25:27 -0300 Subject: [PATCH] Add info on how to make docs for exs --- CONTRIBUTING.MD | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.MD b/CONTRIBUTING.MD index 2fad21a..c88067b 100644 --- a/CONTRIBUTING.MD +++ b/CONTRIBUTING.MD @@ -8,13 +8,16 @@ 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** -**[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 @@ -22,7 +25,7 @@ We try not to have strong boundaries in what kinds of contributions are accepted #### 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 @@ -33,6 +36,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 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/).