-
Notifications
You must be signed in to change notification settings - Fork 60
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update license files to match latest model
- Loading branch information
1 parent
0299f87
commit c1baa49
Showing
2 changed files
with
16 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,36 +1,22 @@ | ||
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](http://www.w3.org/Consortium/Patent-Policy-20040205/) and | ||
[Document License](http://www.w3.org/Consortium/Legal/copyright-documents). To bring substantive contributions to specifications, you must either participate | ||
[W3C Patent Policy](https://www.w3.org/Consortium/Patent-Policy/) and | ||
[Software and Document License](https://www.w3.org/Consortium/Legal/copyright-software). To make 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, | ||
<pre>Contributors: +@githubusername1, +@githubusername2, ...</pre> | ||
|
||
### 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](https://github.com/w3c/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. | ||
If you are not the sole contributor to a contribution (pull request), please identify all | ||
contributors in the pull request comment. | ||
|
||
1. Follow the instructions on "Local use" to setup the scripts. | ||
2. Run: ```make -f ../webrtc-respec-ci/Makefile linewrap LINEWRAPLENGTH=80```. | ||
To add a contributor (other than yourself, that's automatic), mark them one per line as follows: | ||
|
||
### 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. | ||
``` | ||
+@github_username | ||
``` | ||
|
||
### Linked Names | ||
Make names of interfaces, enums and other identifiers clickable like this ```<code><a>MediaStreamTrack</a></code>```. | ||
If you added a contributor by mistake, you can remove them in a comment with: | ||
|
||
### 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. | ||
``` | ||
-@github_username | ||
``` | ||
|
||
### 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 | ||
If you are making a pull request on behalf of someone else but you had no part in designing the | ||
feature, you can remove yourself with the above syntax. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,4 @@ | ||
All documents in this Repository are licensed by contributors | ||
under the | ||
under the | ||
[W3C Software and Document License](https://www.w3.org/Consortium/Legal/copyright-software). | ||
|