Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
79 lines (63 loc) · 3.3 KB

CONTRIBUTING.md

File metadata and controls

79 lines (63 loc) · 3.3 KB

Contributing

Please refer to the group's Work Mode.

Contributions to this repository are intended to become part of Recommendation-track documents governed by the W3C Patent Policy and Software and Document License. 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 pull request comment.

To add a contributor (other than yourself, that's automatic), mark them one per line as follows:

+@github_username

If you added a contributor by mistake, you can remove them in a comment with:

-@github_username

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.

Bikeshed

The Open Screen Protocol spec is maintained with Bikeshed, which has instructions for installing the necessary tools on common platforms, and the document syntax based on Markdown.

Things you can do:

  • make lint checks the input document for errors.
  • make watch runs in the background and regenerates index.html immediately after you modify index.bs.

Using GitHub

Direct contributions to the spec should be made using the Fork & Pull model. The openscreenprotocol directory contains the spec source index.bs, the messages definition messages_appendix.cddl, and a Makefile to generate the spec.

  1. Before doing any local changes, it is a good idea to ensure your fork is up-to-date with the upstream repository: 
    git fetch upstream
git merge upstream/main
  2. In the openscreenprotocol directory, update the spec source index.bs with your changes.
  3. Review your changes and commit them locally: 
     git diff
 git add index.bs
 git commit -m "Your commit message"

How to write a Git commit message

  1. Push your changes up to your GitHub fork, assuming YOUR_FORK_NAME is the name of your remote, and you are working off of the default main branch: 
    git push YOUR_FORK_NAME main

Note: use the default main branch for minor changes only. For more significant changes, please create a new branch instead.

  1. On GitHub, navigate to your fork https://github.com/YOUR_GITHUB_USERNAME/openscreenprotocol and create a pull request with your changes.
  2. Assuming there are no concerns from the group in a reasonable time, the editor will merge the changes to the upstream webscreens/openscreenprotocol repository, and the Editor's Draft hosted at https://webscreens.github.io/openscreenprotocol/ is automatically updated.
  3. Pull requests sometimes contain work-in-progress commits such as "fix typos" or "oops" commits, that do not need to be included in the Git history of the main branch. By default, the editor will merge such pull requests with the Squash and merge option provided by GitHub to create only one commit in the Git history.