Skip to content

Commit e8a8ccb

Browse files
JAORMXclaude
andauthored
Add guide for writing rule types (#351)
* Add comprehensive guide for writing rule types This commit adds documentation to help developers write custom rule types. The guide includes: - Complete rule type anatomy and structure - Detailed explanations of ingestion, evaluation, and remediation - Multiple working examples from this repository - Best practices and common patterns - Quick reference for syntax and built-in functions Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]> * Address PR feedback on rule type documentation - Add link to Open Policy Agent documentation for Rego - Add guidance about parameter design to avoid overly configurable rules that can contradict their security purpose 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]> --------- Co-authored-by: Claude <[email protected]>
1 parent c3cb1ef commit e8a8ccb

File tree

3 files changed

+1698
-1
lines changed

3 files changed

+1698
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,23 @@ The entity itself, however, always originates from a provider.
2525

2626
## How to get started with writing rules and profiles?
2727

28-
To get started with writing rules and profiles, you can check the following resources:
28+
### Quick Start Guides
29+
30+
For comprehensive, repository-specific guides on writing rule types:
31+
- **[Writing Rule Types: Comprehensive Guide](./docs/writing-rule-types.md)** - In-depth guide with examples and best practices
32+
- **[Rule Type Quick Reference](./docs/rule-type-quick-reference.md)** - Concise syntax reference for quick lookup
33+
34+
### Official Minder Documentation
35+
2936
- [How to write a rule type](https://mindersec.github.io/how-to/custom-rules)
3037
- [How to write a rule type using Rego](https://mindersec.github.io/how-to/writing-rules-in-rego)
3138
- [How to use mindev to develop and debug rule types](https://mindersec.github.io/how-to/mindev)
3239
- [How to write rules and profiles - YouTube](https://www.youtube.com/watch?v=eXp0nyd72d4)
3340
- [Minder documentation](https://mindersec.github.io)
3441
- [Rego language tutorial](https://www.openpolicyagent.org/docs/latest/policy-language/)
3542

43+
### Reference Examples
44+
3645
Apart from that, you can also check the reference rules and profiles in this repository to get an idea of how to write, structure, and organize them.
3746

3847
- Rule types: the reference rule types are available in the `rule-types` directory. To take these rule types

0 commit comments

Comments
 (0)