Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating docs with notes about documentation. #203

Merged
merged 6 commits into from
Mar 30, 2020
Merged
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 14 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,25 @@ See the next section for how to adapt to upstream changes.

### Branching Strategy

By default development happens in branches, which are merged via pull requests.
By default, development happens in branches, which are merged via pull requests.
Special cases, like fixing problems with the CI pipeline, are of course exempt from this guideline.

Please make sure to give branches a meaningful name!
As an example, the one creating this documentation was called `branching-merging-documentation`.

### Documentation

When a new extension was added (or significant changes were made) please update the documentation.
To add documentation for an undocumented extension add an entry in the `docs/docs-nav.yml` file and create a new `.adoc` file for the extension.
To ensure that a linebreak is properly displayed in the resulting documentation ensure to write **one and only one sentence per line**.
This rule also applies for very short sentences like _"Tests must be fast!"_.
If long as text blocks are not separated by an empty line, they are treated as one paragraph and without line breaks, regardless existing ones. This means you need to apply at least an empty line if you want to have text separated.

For further information regarding formatting, and how to use AsciiDoctor please use the [Writers Guide](https://asciidoctor.org/docs/asciidoc-writers-guide/).

Do **not** update the `release-notes.md` file!
This file will be generated automatically.

### Commits

While it is nice to have each individual commit pass the build, this is not a requirement - it is the contributor's branch to play on.
Expand Down