You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.MD
+17-8Lines changed: 17 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -8,21 +8,25 @@ The intention set for this repository is for it to be a place that's built by th
8
8
9
9
## Table of contents
10
10
11
-
-**[Contributing a new example](#contributing-a-new-example)**
12
-
-**[Recommended guidelines for an example](#recommended-guidelines-for-an-example)**
13
-
-**[Running the tests](#running-the-tests)**
14
-
-**[Contributing a new resource](#contributing-a-new-resource)**
15
-
-**[Recommended guidelines for a resource](#recommended-guidelines-for-a-resource)**
16
-
-**[Reporting a bug](#reporting-a-bug)**
17
-
-**[Opening an enhancement issue](#opening-an-enhancement-issue)**
11
+
12
+
-**[Contributing a new example](Contributing-a-new-example)**
13
+
-**[Recommended guidelines for an example](Recommended-guidelines-for-an-example)**
14
+
-**[Running the tests](Running-the-tests)**
15
+
16
+
-**[Contributing a new resource](Contributing-a-new-resource)**
17
+
-**Recommended guidelines for a resource**
18
+
19
+
-**[Reporting a bug](Reporting-a-bug)**
20
+
21
+
-**[Opening an enhancement issue](Opening-an-enhancement-issue)**
18
22
19
23
### Contributing a new example
20
24
21
25
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.
22
26
23
27
#### Recommended guidelines for an example
24
28
25
-
Here are some great examples of contributions:
29
+
Here are some great general examples of what a good contribution might be(not restrict:
26
30
27
31
- it showcases PyScript power to leverage other tools (either from the JavaScript or the Python ecosystem)
28
32
- it expands on the PyScript documentation, making the use of PyScript clearer to users
@@ -33,6 +37,11 @@ Adding meta-data:
33
37
- 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)
34
38
- 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)
35
39
40
+
Adding docs:
41
+
42
+
PyScript strives to be accessible to beginners, if you're writing code that might be confusing please add comments explaining your choices.
43
+
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.
44
+
36
45
#### Running the tests
37
46
38
47
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/).
0 commit comments