Skip to content

Commit 2bf032e

Browse files
committed
chore: provide docs
Signed-off-by: Tomas Weiss <tomas.weiss2@gmail.com>
1 parent 8e8b2d9 commit 2bf032e

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

.github/workflows/docs-check.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ jobs:
5252
exit 0
5353
fi
5454
55-
if grep -q '^docs/' changed_files.txt; then
55+
if grep -qE '^(docs/|CONTRIBUTING\.md$|README\.md$|CODE_OF_CONDUCT\.md$)' changed_files.txt; then
5656
echo "✅ Docs updated."
5757
else
5858
echo "❌ No docs changes found and 'No Docs Needed' not checked."

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -331,3 +331,9 @@ Use the release script:
331331
mise run release
332332
```
333333

334+
335+
## Documentation
336+
337+
All changes that modify existing features or introduce new functionality must include documentation updates as part of the pull request. Documentation files should be added or updated in the `docs` folder.
338+
339+
A GitHub workflow automatically checks that documentation requirements are met. If your change does not require documentation updates (e.g., bug fixes that don't change behavior, internal refactoring, or test-only changes), you must explicitly note this in your PR description.

0 commit comments

Comments
 (0)