diff --git a/CONTRIBUTING.MD b/CONTRIBUTING.MD index 2fad21a..198e773 100644 --- a/CONTRIBUTING.MD +++ b/CONTRIBUTING.MD @@ -6,15 +6,15 @@ This file will guide you through how to make your first community contribution, 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. -### Table of contents: +## 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](#recommended-guidelines-for-a-resource)** +- **[Reporting a bug](#reporting-a-bug)** +- **[Opening an enhancement issue](#opening-an-enhancement-issue)** ### Contributing a new example @@ -33,7 +33,7 @@ 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) -#### Running tests +#### Running the 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/). @@ -45,7 +45,13 @@ Remember to have the right path set up for your `css` and `script` tags. They sh 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. -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. +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.* + +#### Recommended guidelines for a resource + +TBD ### Reporting a bug @@ -55,4 +61,3 @@ Please follow the guidelines on the Issue template. ### Opening an enhancement issue 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. -