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
+16-11Lines changed: 16 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -6,15 +6,15 @@ This file will guide you through how to make your first community contribution,
6
6
7
7
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.
8
8
9
-
###Table of contents:
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**
16
-
**[Reporting a bug](Reporting-a-bug)**
17
-
**[Opening an enhancement issue](Opening-an-enhancement-issue)**
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)**
18
18
19
19
### Contributing a new example
20
20
@@ -33,7 +33,7 @@ Adding meta-data:
33
33
- 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
34
- 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
35
36
-
#### Running tests
36
+
#### Running the tests
37
37
38
38
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/).
39
39
@@ -45,7 +45,13 @@ Remember to have the right path set up for your `css` and `script` tags. They sh
45
45
46
46
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.
47
47
48
-
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.
48
+
The contributions in this topic are more similar to what an `awesome-page` would look like.
49
+
50
+
*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.*
51
+
52
+
#### Recommended guidelines for a resource
53
+
54
+
TBD
49
55
50
56
### Reporting a bug
51
57
@@ -55,4 +61,3 @@ Please follow the guidelines on the Issue template.
55
61
### Opening an enhancement issue
56
62
57
63
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.
0 commit comments