Skip to content

docs: add STYLE_GUIDE.md for rules doc comments (closes #150) #364

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
koiakoia wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: add STYLE_GUIDE.md for rules doc comments (closes #150) #364

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
af134ef
Add STYLE_GUIDE.md for rules doc comments
koiakoia Apr 29, 2026
be40a7e
Address review feedback: override syntax + correct SSH allowlist example
koiakoia May 19, 2026
79f6c33
Move STYLE_GUIDE.md into docs/ for mkdocs discovery
koiakoia May 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ This repository includes a dedicated guide for contributing rules, outlining the

All rules must be licensed under the [Apache 2.0 License](./LICENSE).

For comment and documentation conventions within rule files (doc comments,
section comments, tuning-macro override examples, and list provenance), see
**[STYLE_GUIDE.md](STYLE_GUIDE.md)**.
Copy link
Copy Markdown
Member

@leogr leogr May 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**[STYLE_GUIDE.md](STYLE_GUIDE.md)**.
**[STYLE_GUIDE.md](docs/STYLE_GUIDE.md)**.

Since the file lives under docs/ now, this link needs the prefix, otherwise it 404s from CONTRIBUTING.md 🙏



**Table of Contents**

Expand Down
Loading
Loading