You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/instructions/documentation.instructions.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
11
11
12
12
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.
13
13
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
+
14
16
General rules:
15
17
- clear, precise and technical tone, not promotional
0 commit comments