Skip to content

Add contributing guidelines #3

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

Open
andreubotella wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add contributing guidelines #3

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
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Contributing Guidelines

Anyone is welcome to make PRs for editorial changes to the specification. These include typo fixes, rewordings, or any other changes that don't affect the meaning of the spec.

To submit normative changes, however, you will need to be a WinterTC delegate or invited expert. [See here for more information.](https://github.com/WinterTC55/?view_as=public#joining-the-committee)

## Building the spec

WinterTC specifications are developed using [Bikeshed](https://speced.github.io/bikeshed).

If you have Python 3.9 or higher on your system, you can install Bikeshed with:

```sh
pip3 install bikeshed
```

For other ways of installing it, [see the Bikeshed documentation](https://speced.github.io/bikeshed/#installing).

Then, you can build the specification using:

```sh
bikeshed spec index.bs index.html
```

You might also find the `bikeshed watch` and `bikeshed serve` commands useful.