Skip to content

Commit 2e22aeb

Browse files
committed
Enhance FAQ and index documentation to include support for Claude Code and clarify Project CodeGuard's multi-stage application in code generation. Added details on how Project CodeGuard rules can be utilized before, during, and after code generation for improved security practices.
1 parent 5431147 commit 2e22aeb

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

docs/faq.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,13 @@ This FAQ document provides clear, concise answers to help developers seamlessly
2525

2626
---
2727

28+
## Q: Can I use this with Claude Code?
29+
30+
**A:** Yes! Claude Code automatically reads and follows instructions from a `CLAUDE.md` file in your project root. To use Project CodeGuard rules with Claude Code you can point to the Project CodeGuard rules in your `CLAUDE.md` file.
31+
32+
You can point to the Project CodeGuard rules in your `CLAUDE.md` file. When Claude Code operates in your project, it treats the Project CodeGuard security rules in `CLAUDE.md` as authoritative system instructions.
33+
34+
2835
## Q: How can I report a problem or enhancement to any of the rules?
2936

3037
**A:** You can report problems, successes, or suggest enhancements to any of the rules by:
@@ -67,3 +74,6 @@ See [CONTRIBUTING.md](https://github.com/project-codeguard/rules/blob/main/CONTR
6774

6875
- [Open an issue](https://github.com/project-codeguard/rules/issues) with your question
6976
- [Start a discussion](https://github.com/project-codeguard/rules/discussions) to chat with the community
77+
78+
79+

docs/index.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,13 @@ AI coding agents are transforming software engineering, but this speed can intro
1515

1616
Project CodeGuard solves this by embedding security best practices directly into AI coding agent workflows.
1717

18-
**During and After Code Generation.**
18+
**Before,During, and After Code Generation.**
1919

20-
These rules can be used for:
21-
- preventing vulnerabilities from being introduced during code generation
22-
- automated code review by AI agents
20+
Project CodeGuard can be used **before**, **during** and **after** code generation. They can be used at the AI agent planning phase or for initial specification-driven engineering tasks. Project CodeGuard rules can also be used to prevent vulnerabilities from being introduced during code generation. They can also be used by automated code-review AI agents.
21+
22+
For example, a rule focused on input validation could work at multiple stages: it might suggest secure input handling patterns during code generation, flag potentially unsafe user or AI agent input processing in real-time and then validate that proper sanitization and validation logic is present in the final code. Another rule targeting secret management could prevent hardcoded credentials from being generated, alert developers when sensitive data patterns are detected, and verify that secrets are properly externalized using secure configuration management.
23+
24+
This multi-stage methodology ensures that security considerations are woven throughout the development process rather than being an afterthought, creating multiple layers of protection while maintaining the speed and productivity that make AI coding tools so valuable.
2325

2426

2527
## Security Coverage

0 commit comments

Comments
 (0)