Skip to content

Commit 50d7d45

Browse files
authored
Merge pull request #18 from tildebyte/markdown-fixups-for-contributing-again
Fixups for CONTRIBUTING.MD...
2 parents e04d3a3 + b8796fe commit 50d7d45

File tree

1 file changed

+18
-21
lines changed

1 file changed

+18
-21
lines changed

CONTRIBUTING.MD

Lines changed: 18 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,39 +8,35 @@ The intention set for this repository is for it to be a place that's built by th
88

99
## Table of contents
1010

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)**
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)**
2218

2319
### Contributing a new example
2420

2521
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.
2622

2723
#### Recommended guidelines for an example
2824

29-
Here are some great general examples of what a good contribution might be(not restrict:
25+
- Here are some great general examples of what a good contribution might be (not restrictive)
3026

31-
- it showcases PyScript power to leverage other tools (either from the JavaScript or the Python ecosystem)
32-
- it expands on the PyScript documentation, making the use of PyScript clearer to users
33-
- it offers engaging educational material
27+
- it showcases PyScript power to leverage other tools (either from the JavaScript or the Python ecosystem)
28+
- it expands on the PyScript documentation, making the use of PyScript clearer to users
29+
- it offers engaging educational material
3430

35-
Adding meta-data:
31+
- Adding meta-data
3632

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)
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)
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+
- 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)
3935

40-
Adding docs:
36+
- Adding docs
4137

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.
38+
- PyScript strives to be accessible to beginners. If you're writing code that might be confusing, please add comments explaining your choices.
39+
- 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.
4440

4541
#### Running the tests
4642

@@ -65,6 +61,7 @@ TBD
6561
### Reporting a bug
6662

6763
You can contribute a bug you found on the tests, examples, or any other technical part of the infrastructure of this repository.
64+
6865
Please follow the guidelines on the Issue template.
6966

7067
### Opening an enhancement issue

0 commit comments

Comments
 (0)