The specification is built using Bikeshed. If you would like to propose edits, please make sure that they result in a specification that will build correctly, by testing in your own clone of the repository.
- Install bikeshed
- From the HTML folder open a command prompt
- run bikeshed:
For the multipage version, one can do as follows:
- Install multipage
- Follow the instructions there to regenerate the HTML files
Contributing to this Repository
Use the standard fork, branch, and pull request workflow to propose changes to the specification. Please make branch names informative - by including the issue or bug number for example.
More information on contributing is in CONTRIBUTING.md.
To make changes to the specification:
- Edit single-page.bs (or one of the include files it references) in the
masterbranch. Do not edit the HTML files in the
gh-pagesbranch. These are built automatically.
- Ideally run bikeshed on single-page.bs to make sure there are no errors (run
- Create a pull request but do not include the single-page.html file
- When the editors merge and commit your pull request Travis-CI will build the HTML files
The following considerations should be kept in mind when making a pull request:
- Editorial changes that improve the readability of the spec or correct spelling or grammatical mistakes are welcome.
- Ideally new features should be proposed in a new specification and not as additions to the HTML spec. The Web Platform WG charter requires that the WG only adopt new proposals after they have been through an incubation phase. Please consider the WICG's Intent to Migrate template when proposing new features.
- Normative changes to the spec should aim to improve interoperability amongst browsers. Such changes should be accompanied by a test case to show that the change does this. It may also include links to bug trackers for browsers showing that there is an intent to adopt the new behaviour.
- Normative changes to the spec should be associated with a bug or issue that describes the reason for the change.
Old HTML repository
The old HTML repo is available for archival purposes.