Skip to content

Commit

Permalink
docs: correct title casing in style guide
Browse files Browse the repository at this point in the history
  • Loading branch information
xynydev committed Oct 1, 2023
1 parent 7e08a38 commit 2fb7aef
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion modules/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ set -oue pipefail

### README

- Title should be "`type` module for startingpoint", where the name/type of the module is a noun that shows the module's purpose
- Title should be "`type` Module for Startingpoint", where the name/type of the module is a noun that shows the module's purpose
- There should be a subtitle "Example configuration", under which there should be a loosely documented yaml block showcasing each of the module's configuration options
- At the start of each paragraph, refer to the module using its name or with "the module", not "it" or "the script"
- Use passive grammar when talking about the user, ie. "should be used", "can be configured", preferring references to what the module does, ie. "This module downloads the answer to the question of life, the universe and everything..."

0 comments on commit 2fb7aef

Please sign in to comment.