Skip to content

Commit 8f3bc9f

Browse files
authored
Merge pull request #25 from project-codeguard/feature/updating-readme-badges
2 parents e65db3f + 1855172 commit 8f3bc9f

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
# Project CodeGuard: Security Rules for AI Coding Agents
2+
![Securing](https://img.shields.io/badge/Securing%20AI%20Generated%20Code-green)
3+
![Open Source](https://img.shields.io/badge/Now-Open%20Source-brightgreen)
4+
[![License: CC BY 4.0](https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by/4.0/)
25

36
This project is an AI model-agnostic security framework and ruleset (internally nicknamed "Project CodeGuard" when developed at Cisco) that embeds secure-by-default practices into AI coding workflows (generation and review). It ships core security rules, translators for popular coding agents, and validators to test rule compliance.
47

@@ -18,9 +21,10 @@ Project CodeGuard solves this by embedding security best practices directly into
1821

1922
**During and After Code Generation.**
2023

21-
These rules can be used for:
22-
- preventing vulnerabilities from being introduced during code generation
23-
- automated code review by AI agents
24+
Project CodeGuard is designed to integrate seamlessly across the entire AI coding lifecycle.
25+
- **Before code generation**, rules can be used for the design of a product and for spec-driven development. You can use the rules in the “planning phase” of an AI coding agent to steer models toward secure patterns from the start.
26+
- **During code generation**, rules can help AI agents to prevent security issues as code is being written.
27+
- **After code generation**, AI agents like Cursor, GitHub Copilot, Codex, Windsurf, and Claude Code can use the rules for code review.
2428

2529

2630
## Security Coverage

docs/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ This FAQ document provides clear, concise answers to help developers seamlessly
2929

3030
**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.
3131

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.
32+
When Claude Code operates in your project, it treats the Project CodeGuard security rules in `CLAUDE.md` as authoritative system instructions.
3333

3434

3535
## Q: How can I report a problem or enhancement to any of the rules?

0 commit comments

Comments
 (0)