Skip to content

Commit 596e6e1

Browse files
committed
Basic contributing guide
1 parent c77e6a7 commit 596e6e1

File tree

2 files changed

+46
-2
lines changed

2 files changed

+46
-2
lines changed

CONTRIBUTING.MD

+41-2
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,57 @@
22

33
Thank you for taking the time to contribute to the PyScript Collective!
44

5-
This file will guide you through how to make your first community contribution, if you're looking for contributing to PyScript Core, please head over to [this](https://github.com/pyscript/pyscript) repository.
5+
This file will guide you through how to make your first community contribution, if you're looking to contribute to PyScript Core, please head over to [this](https://github.com/pyscript/pyscript) repository.
66

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 on tasks like onboarding new folks, co-maintaining examples and keeping them and enriching this repository with their own perspectives. It's a space for users and contributors to discuss on how the community should be shaped.
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.
88

99
### Table of contents:
1010

1111
**[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**
1216
**[Reporting a bug](Reporting-a-bug)**
1317
**[Opening an enhancement issue](Opening-an-enhancement-issue)**
1418

1519
### Contributing a new example
1620

21+
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+
23+
#### Recommended guidelines for an example
24+
25+
Here are some great examples of contributions:
26+
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
30+
31+
Adding meta-data:
32+
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)
35+
36+
#### Running tests
37+
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+
40+
Run `make test` on the root repository to run the tests locally.
41+
42+
Remember to have the right path set up for your `css` and `script` tags. They should point to your local build instead of PyScript's self-hosted version.
43+
44+
### Contributing a new resource
45+
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+
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.
49+
1750
### Reporting a bug
1851

52+
You can contribute a bug you found on the tests, examples, or any other technical part of the infrastructure of this repository.
53+
Please follow the guidelines on the Issue template.
54+
1955
### Opening an enhancement issue
56+
57+
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.
58+

examples/hello_world.html

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
<!--
2+
contributor: [email protected]
3+
tags: example-tag, another-example
4+
-->
5+
16
<!DOCTYPE html>
27
<html lang="en">
38
<head>

0 commit comments

Comments
 (0)