Skip to content

Commit 99b2678

Browse files
committed
Update documentation instructions to clarify inclusion of workflows and CI/CD pipelines in README.md
1 parent e673621 commit 99b2678

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

.github/instructions/documentation.instructions.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1111

1212
All documentation in the `docs/` directory should have a speaking filename and a **Last updated**: YYYY-MM-DD date at the top of the file.
1313

14+
Workflows and CI/CD pipelines should be mentioned in a short list on the bottom of the `README.md`. There is no deep dive documentation needed and they also do not need to be mentioned in the `CHANGELOG.md`.
15+
1416
General rules:
1517
- clear, precise and technical tone, not promotional
1618
- avoid redundancies

0 commit comments

Comments
 (0)