Skip to content

Commit 4e8db34

Browse files
committed
Add Style Guide to README, with note about links and about standard vs specification
1 parent 22a7491 commit 4e8db34

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,19 @@ To edit the user guide:
1515

1616
We'd like to ask you to familiarize yourself with our [Contribution Guide](CONTRIBUTING.md).
1717

18+
## Style Guide
19+
20+
We must use CWL standards or CWL open standards when talking about CWL.
21+
We must use specification only when talking specifically about the CWL
22+
specification document.
23+
24+
Whenever a page is updated we must verify that it does not break existing
25+
links. The `make html` command will fail if Sphinx detects broken links.
26+
It only works for links managed by Sphinx (i.e. table of contents links,
27+
or links to Markdown pages). For simple HTML links (e.g. `< href=>` or
28+
markdown external links) pull request reviewers must verify that links
29+
are still working after the change.
30+
1831
### Code examples
1932

2033
To include code into a Markdown file you have two options. For external files use
@@ -39,7 +52,7 @@ you will have to customize the Sphinx and Pygments settings.
3952
To preview Pygments output with different styles, use their
4053
[Pygments demo tool](https://pygments.org/demo/).
4154

42-
### Links
55+
### Creating Links
4356

4457
Sphinx and the theme are configured to auto-generate anchor slug
4558
links for sections. So sections like ``## cwl standard`` are translated

0 commit comments

Comments
 (0)