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.

Sign up for GitHub

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

Jump to bottom

Updating docs with notes about documentation. #203

Merged
merged 6 commits into from
Mar 30, 2020
Merged

Updating docs with notes about documentation. #203

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f4dd28e
Updating docs with notes about documentation.
Bukama Mar 27, 2020
cecc1e5
Accepting aepflis improvements
Bukama Mar 28, 2020
469b268
Update CONTRIBUTING.md
Bukama Mar 28, 2020
4d9ad78
Update CONTRIBUTING.md
Bukama Mar 28, 2020
4605b24
Pulling a Nicolai-needs-to-rewrite-everything
Mar 29, 2020
bf31f7b
Merge branch 'master' into issue191/onelineasciidoc
Bukama Mar 29, 2020
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
13 changes: 12 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,23 @@ 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 the documentation for a new extension add a new entry in the `docs/docs-nav.yml` file and add a new `.adoc` file for the new extension.
Bukama marked this conversation as resolved.
Show resolved Hide resolved
To ensure that a linebreak is properly displayed in the resulting documentation ensure to write **one and only one sentence per line**.
Do this also for very short sentences like _"Tests must be fast!"_.
Bukama marked this conversation as resolved.
Show resolved Hide resolved
As long as there is no empty line is between to lines of text then the sentences will be displayed like they were written in one line, but will be wraped dynamically of the readers screen resolution.
Bukama marked this conversation as resolved.
Show resolved Hide resolved

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