Skip to content
This repository has been archived by the owner on Nov 11, 2019. It is now read-only.

Commit

Permalink
Update working documentation
Browse files Browse the repository at this point in the history
* Update changes in the README
* Reference Code of conduct, webplat WG
* Explain contributing procedures a bit more
  • Loading branch information
chaals committed Nov 11, 2017
1 parent 7e00122 commit 1013f8c
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 11 deletions.
49 changes: 42 additions & 7 deletions CONTRIBUTING.md
@@ -1,11 +1,49 @@
# Web Platform Working Group

Contributions to this repository are intended to become part of Recommendation-track documents governed by the
## Contributing to the microdata spec.

Please feel free to file issues against the specification, or to propose a fix for an existing issue.
The preferred way to do this is through raising github issues and making github pull requests.
If you are uncomfortable with that process, you may also send comments by email to public-webapps@w3.org,
with a subject that **begins** with the text `[microdata] `. All email comments will be available in a
[public archive](https://lists.w3.org/Archives/Public/public-webapps).

If you are not a participant in the [W3C Web Platform Working Group](https://w3.org/WebPlatformWG)
your contributions may be marked as having "IPR issues". If the contributions are purely editorial,
this will be handled by the editors, but if they involve changes to conformance, such as new features,
they will not be accepted without a formal agreement to W3C's intellectual property policies (see below for more)

### Issues
Issues should describe the problem. Proposals to fix it can be made as comments on the issue,
but should include known implementation of the proposal.

If you want to make a Pull request for simple editorial corrections, it is not necessary to raise an issue.

### Pull requests
The best way to propose a fix is to make a branch,
commit your changes to the branch and then create a Pull Request. Pull Requests should inclue the following information:

; Does it fix a known issue?
: If so, add `Fix #333, #222` in a line by itself in a comment, which will close the issue
; Does it relate to a known issue?
: If so, add a comment like `see also #444, #111`, and preferably an explanation of how it relates.
: If not, and it is more than merely editorial, please open an issue
; Known implementation of the change
; Links to tests for any changed behaviour
: Ideally these will be in the form of Web-platform-tests but there are things that can require a manual test.
; Acknowledgements and changelog updates
: If the issue has been worked on by somebody who is not acknowledged already in the acknolwedgements section,
please add their name
: If the change is substantive, i.e. affects conformance, or a significant editorial one, please note it in the changes section

## Licensing and IPR

Contributions to this repository are expected to become part of a Recommendation governed by the
[W3C Patent Policy](http://www.w3.org/Consortium/Patent-Policy-20040205/) and
[Software and Document License](http://www.w3.org/Consortium/Legal/copyright-software). To make substantive contributions to specifications, you must either participate
[W3C Software and Document License](http://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
If you are not the only contributor to a proposal resulting in a 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:
Expand All @@ -14,11 +52,8 @@ To add a contributor (other than yourself, that's automatic), mark them one per
+@github_username
```

If you added a contributor by mistake, you can remove them in a comment with:
If you added a contributor by mistake in an earlier comment, 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.
27 changes: 23 additions & 4 deletions README.md
Expand Up @@ -6,12 +6,31 @@ This work aims to bring the specification in line with deployed implementations

[Substantive changes](https://w3c.github.io/microdata/#changes) are documented in the specification, major technical changes include:

In the [26 June Working Draft](https://www.w3.org/TR/2017/WD-microdata-20170626/)
* Remove special Drag-and-Drop functionality
In the current editors' draft:
* Clarify that microdata does not guarantee ordering of properties
* Remove the conversion to JSON-LD


In the [10 October Working Draft](https://www.w3.org/TR/2017/WD-microdata-20171010/):
* Add a normative algorithm to convert microdata to RDFa
* Add a normative algorithm to convert microdata to JSON-LD

Changes in previous Working Drafts include:
* Remove the special unimplemented Drag-and-Drop functionality
* Use `itemtype` as a vocabulary identifier.
* Add a global `content` attribute as a mechanism to explicitly define property values
* Allow `data`, `meter` and `time` elements to use their text content as a value.
* Allow `itemid` more liberally.

In the [First Public Working Draft](https://www.w3.org/TR/2017/WD-microdata-20170504/)
* Allow for the use of microdata in languages other than HTML
* Remove the Microdata DOM API

## Participating in the work
This specification is formally managed by the [W3C Web Platform Working Group](https://w3.org/WebPlatformWG).
Further information about contributing to this document is available in [the guide to contributing](CONTRIBUTING.md).

All W3C activity, including working in this repository, is conducted according to the W3C Code of Conduct,
to help ensure a friendly, resepectful environment for discussion.
In the unlikely and unfortunate event that you are aware of a breach of that code,
as well as being able to follow the procedures listed in the Code or further procedures relevant to the circumstance,
you are welcome to contact any of the editors, chairs and staff of the Web Platform Working Group in confidence,
who will do their best to assist you in following up and fixing problems.

0 comments on commit 1013f8c

Please sign in to comment.