Skip to content

Commit 8b54f01

Browse files
committed
Update Readme and Contributing pages
With details about how issues are being used for discussion, and markup style notes and references.
1 parent 4363d9d commit 8b54f01

File tree

2 files changed

+55
-5
lines changed

2 files changed

+55
-5
lines changed

CONTRIBUTING.md

+37
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,43 @@
22

33
This repository is being used for work in the [W3C Maps For HTML Community Group](https://www.w3.org/community/maps4html/), governed by the [W3C Community License Agreement (CLA)](https://www.w3.org/community/about/agreements/cla/). To make substantive contributions, you must join the CG.
44

5+
## Before making a pull request…
6+
7+
Is it a simple fix, like a typo or an obvious code correction? Go right ahead with a PR.
8+
9+
If it's anything bigger, please start an issue to discuss it first.
10+
You'll also need to join the community group and agree to the IP (intellectual property) commitments.
11+
If you have an employer, you'll either need to get your employer to join the group or you'll need to inform the W3C that your employer doesn't have any IP claims over the work you're contributing.
12+
13+
If you're discussing changes to an existing use case, reference tool, or capability section, check to see if there is already a discussion issue open.
14+
15+
## Markup style
16+
17+
The main report is in the index.html file.
18+
19+
The report uses the [ReSpec](https://github.com/w3c/respec/wiki) specification generator,
20+
with custom code to generate tags, support info, and cross links between use cases and capabilities.
21+
22+
For new use cases and capabilities, there are templates at the bottom of the document.
23+
Copy & paste the `<section>` elements from these templates into place,
24+
then replace the comments with the relevant content.
25+
26+
The report uses [semantic line breaking](https://sembr.org/):
27+
wrap text at the end of every sentence,
28+
and break long sentences after punctuation or other logical separations in the content.
29+
This makes it easier to track edits using commit diffs.
30+
31+
Other code style notes:
32+
33+
- Start and end tags for paragraphs and sectioning elements go on their own line.
34+
- Headings, definition terms, and short list items can have markup and text on the same line.
35+
- Use explicit section elements with `id` values for headings h4 and higher.
36+
- Leave a single empty line between sections or before an h5 heading.
37+
- Don't indent markup for regular body text.
38+
- Use ReSpec auto links wherever possible, especially for references.
39+
40+
## Collaboration
41+
542
If you are not the sole contributor to a contribution (pull request), please identify all
643
contributors in the pull request comment.
744

README.md

+18-5
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,29 @@
1-
# HTML-Map-Element-UseCases-Requirements
2-
Use cases and requirements for Maps on the Web
1+
# Use Cases and Requirements for Maps on the Web
32

4-
This is the home of the current version of the [Use Cases and Requirements for Standardizing Web Maps](https://maps4html.github.io/HTML-Map-Element-UseCases-Requirements/).
3+
This is the home for development of the report [Use Cases and Requirements for Standardizing Web Maps](https://maps4html.github.io/HTML-Map-Element-UseCases-Requirements/)
4+
by the [W3C Maps For HTML Community Group](https://www.w3.org/community/maps4html/).
55

66
## Found a bug? Want to contribute something?
77
If you found a problem with the document, no matter how small,
88
please [file a bug](https://github.com/Maps4HTML/HTML-Map-Element-UseCases-Requirements/issues).
99

10+
Issues are also being used to discuss the content of
11+
[use cases](https://github.com/Maps4HTML/HTML-Map-Element-UseCases-Requirements/issues?q=is%3Aissue+is%3Aopen+label%3A%22discussion%3A+use+case%22),
12+
[reference JavaScript implementations](https://github.com/Maps4HTML/HTML-Map-Element-UseCases-Requirements/issues?q=is%3Aopen+is%3Aissue+label%3A%22discussion%3A+sample+JS+tool%22),
13+
and [capabilities (potential requirements)](https://github.com/Maps4HTML/HTML-Map-Element-UseCases-Requirements/issues?q=is%3Aissue+is%3Aopen+label%3A%22discussion%3A+capability%22),
14+
among [other topics](https://github.com/Maps4HTML/HTML-Map-Element-UseCases-Requirements/issues?&q=is%3Aissue+is%3Aopen+-label%3A%22discussion%3A+use+case%22+-label%3A%22discussion%3A+capability%22+-label%3A%22discussion%3A+sample+JS+tool%22).
15+
The [draft report](https://maps4html.github.io/HTML-Map-Element-UseCases-Requirements/)
16+
includes cross references to the discussion page for each section.
17+
18+
Use those issues to suggest changes to the text, the references and examples, or to the conclusions (which tags apply to which capability and should the capability be a requirement).
19+
20+
Start a new issue to suggest a new use case or capability.
21+
1022
See also our [contributor's guide](CONTRIBUTING.md).
1123

12-
Proposals for normative changes to the specification should take
13-
place on the [Maps4HTML mailing list](mailto:[email protected]).
24+
Broader discussion about the community group projects,
25+
and how this report relates to other activities,
26+
should take place on the [Maps4HTML mailing list](mailto:[email protected]).
1427

1528
## Let me see it!
1629
It's on [github pages, here](https://maps4html.github.io/HTML-Map-Element-UseCases-Requirements/).

0 commit comments

Comments
 (0)