Skip to content

Commit

Permalink
docs: how to refer to modules in module READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
xynydev committed Oct 1, 2023
1 parent 8b48f8c commit 4645605
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion modules/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,5 @@ 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
- 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
- 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"

0 comments on commit 4645605

Please sign in to comment.