Add custom rules documentation and template. #89
Merged
+112
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
thomas-bartlett
added
documentation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for creating custom security rules using the existing CLI infrastructure. It enables users to extend Project CodeGuard with their own organization-specific policies, compliance requirements, or coding standards.
Changes:
- Added a custom rule template file with proper frontmatter schema and example structure
- Created detailed documentation covering the quick start process, frontmatter schema, CLI reference, and usage examples
- Updated README.md to reference the new custom rules documentation
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| sources/templates/custom-rule-template.md.example | Provides a complete template with frontmatter schema and markdown structure for creating custom rules |
| docs/custom-rules.md | Comprehensive documentation covering custom rule creation, CLI usage, validation, and configuration options |
| README.md | Added link to custom rules documentation in the developer section |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds documentation for creating custom rules using the existing CLI infrastructure. Includes a template file and CLI reference for the --source and --tag flags.
Fixes #79