W3C Web of Things Working Group – Web Site Sources
This repository contains the sources for https://www.w3.org/WoT/WG/
Editorial changes that improve the readability of the pages or correct spelling or grammatical mistakes are welcome, and may be done directly from the Web interface of GitHub. However, in general changes should be done by pull requests. Please follow the following guidelines for the contribution workflow:
- Fork the repository, then clone the fork.
- Create a local branch in your fork, push commits there, then make a pull request. After the pull request is merged, the local branch can be optionally deleted.
- Sign the commits (use e.g.
git commit -s -m "message"). - Make commit messages specific and informative, e.g. by including issue numbers.
- For bigger commits, the first line of the commit message should be a short summary, then after an empty line a more detailed description or rationale of the commit should follow.
- Similarly, pull request comments should follow the same principles as commit messages.
- For HTML files please provide a link to a rendered diff in the pull request, using the W3C HTML diff tool for comparing two versions of the same file from different forks and branches. See an example here.
Note that the tool expects the "raw" link to the files, for instance this file's raw link is https://github.com/w3c/wotwg/raw/master/README.md that resolves to https://raw.githubusercontent.com/w3c/wotwg/master/README.md, and can be obtained by clicking on the
Rawbutton when the file is displayed on the github web page.) - Pull requests should be reviewed and approved by someone else (typically an editor), then approved and merged by an editor or chair.
- The preferred way to merge a pull request is by creating a merge commit, or by squashing (select the option from the pull-down menu right to the merge button). To keep full history, rebase merge is fine if commits are well defined and formatted.
Please read CONTRIBUTING.md, about licensing contributions.