Permalink
Browse files

Explain how to preview the built spec in CONTRIBUTING.md. (#263)

  • Loading branch information...
1 parent aea3ac0 commit 228ffcd80d27475d62c2815b3494a436658c9dc3 @jyasskin jyasskin committed on GitHub Aug 5, 2016
Showing with 16 additions and 0 deletions.
  1. +16 −0 CONTRIBUTING.md
View
@@ -1,3 +1,19 @@
+# Contribution mechanics
+
+When sending a pull request that changes a `.bs` file,
+please include a preview URL of the form
+`https://api.csswg.org/bikeshed/?url=https://github.com/{org}/web-bluetooth/raw/{branch}/{spec}.bs`.
+
+You can iterate locally by
+[installing Bikeshed](https://github.com/tabatkins/bikeshed/blob/master/docs/install.md)
+and then running `bikeshed watch {spec}.bs`,
+where `{spec}` is either `index` or `scanning`.
+If you've installed Bikeshed locally,
+then each time you start editing the spec you should
+update it using the instructions at the bottom of that link.
+
+# Legal requirements
+
This repository is being used for work in the W3C Web Bluetooth Community Group.
All contributions are made under the
[W3C CLA](https://www.w3.org/community/about/agreements/cla/).

0 comments on commit 228ffcd

Please sign in to comment.