8000 Fixups for CONTRIBUTING.MD... by tildebyte · Pull Request #10 · pyscript/pyscript-collective · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Fixups for CONTRIBUTING.MD... #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 5, 2022
Merged

Fixups for CONTRIBUTING.MD... #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 16 additions & 11 deletions CONTRIBUTING.MD
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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/).

Expand All @@ -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

Expand All @@ -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.

0