Skip to content

Latest commit

 

History

History
36 lines (26 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

36 lines (26 loc) · 2.51 KB
Raw

Since we are a lot of people contributing to the specification, we have defined a few guidelines. Please follow them and we will be able to review your PR a lot faster when we don't have to point out style and other non-technical issues. Thank you.

W3C Legal

Contributions to this repository are intended to become part of Recommendation-track documents governed by the W3C Patent Policy and Document License. To bring substantive contributions to specifications, you must either participate in the relevant W3C Working Group or make a non-member patent licensing commitment.

If you are not the sole contributor to a contribution (pull request), please identify all contributors in the commit message. In the commit, please include on a new line,

Contributors: +@githubusername1, +@githubusername2, ...

Line Wrapping

Recommendations

Format new text to break each line within 80 characters. If you add a few new words to an existing paragraph, it's OK if that line exceeds 80 characters. If fixing the width means that the next line gets to wide, and so on, it's better to leave it since touching a lot of lines unrelated to the actual fix makes the PR harder to review. We will make automatic re-flows of the document every once in a while.

Automatic Formatting

You can use webrtc-respec-ci to automatically format your code. Note that this script formats the entire document and may change lines that are not part of your original patch. This can make your changes harder to review.

  1. Follow the instructions on "Local use" to setup the scripts.
  2. Run: make -f ../webrtc-respec-ci/Makefile linewrap LINEWRAPLENGTH=80.

Pull Request Names

Choose a name for your PR that would make sense in a change log.
Example: Add support for new attribute X on Y (fixes: #123).
Avoid: Fix for #123.

Linked Names

Make names of interfaces, enums and other identifiers clickable like this <code><a>MediaStreamTrack</a></code>.

Refactoring: Moving Text

If your PR needs to both move a section of text and update it, please do these operations in two separate commits (or even PRs). That will make the review process simpler.

Run Linter on Examples

If you have made a lot of changes to the example code snippets it might be a good idea to run the example linter. For instructions, see https://github.com/w3c/webrtc-respec-ci/blob/master/check-examples/README.md