Skip to content

Commit

Permalink
Update CONTRIBUTING.md with notes about documentation
Browse files Browse the repository at this point in the history
So far, the approach to documenting[1] features was not documented in
our documentation[2]. This PR documents in our documentation[2] how to
document[1] features. :)

PR: #203
Closes: #191


[1] user-facing documentation on https://junit-pioneer.org/docs/
[2] developer-facing documentation in CONTRIBUTING.md

[ci skip-release]
  • Loading branch information
Bukama committed Mar 30, 2020
1 parent 6fe755b commit f62b769
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,30 @@ 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

Each feature is documented on [the project website](https://junit-pioneer.org/docs/), which is pulled from the files in the `docs/` folder, where each feature has:

* an entry in `docs-nav.yml` (lexicographically ordered)
* it's own `.adoc` file

Add these entries when implementing a new feature and update them when changing an existing one.

For information on how to use AsciiDoctor, check its [user manual](https://asciidoctor.org/docs/user-manual/) and [writer's guide](https://asciidoctor.org/docs/asciidoc-writers-guide/).
One project-specific requirement:

* one sentence per line, i.e. no matter how short or long a sentence is, it will occupy a single line, not shared with any other sentences
* to start a new paragraph, add a single blank line

Finally, do **not** update the `release-notes.md` file!
This file is 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

0 comments on commit f62b769

Please sign in to comment.