Skip to content

Commit 7a64748

Browse files
authored
Merge pull request #1 from project-codeguard/docs/github-org-docs
Update README.md
2 parents 83cbc59 + b934296 commit 7a64748

2 files changed

Lines changed: 45 additions & 0 deletions

File tree

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,27 @@
11
# .github
22
Central repository for managing common GitHub configurations and contributing guidelines across all projects.
3+
---
4+
5+
[Project CodeGuard](https://github.com/project-codeguard/rules) is an open-source, model-agnostic security framework that embeds secure-by-default practices into AI coding agent workflows. It provides comprehensive security rules that guide AI assistants to generate more secure code automatically.
6+
7+
## Why Project CodeGuard?
8+
9+
AI coding agents are transforming software engineering, but this speed can introduce security vulnerabilities. Is your AI coding agent implementation introducing security vulnerabilities?
10+
11+
- ❌ Skipping input validation
12+
- ❌ Hardcoding secrets and credentials
13+
- ❌ Using weak cryptographic algorithms
14+
- ❌ Relying on unsafe functions
15+
- ❌ Missing authentication/authorization checks
16+
- ❌ Missing any other security best practice
17+
18+
Project CodeGuard solves this by embedding security best practices directly into AI coding agent workflows.
19+
20+
**Before, During, and After Code Generation.**
21+
22+
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.
23+
24+
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.
25+
26+
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.
27+

profile/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Project CodeGuard
2+
3+
[Project CodeGuard](https://github.com/project-codeguard/rules) is an open-source, model-agnostic security framework that embeds secure-by-default practices into AI coding agent workflows. It provides comprehensive security rules that guide AI assistants to generate more secure code automatically.
4+
5+
## Why Project CodeGuard?
6+
7+
AI coding agents are transforming software engineering, but this speed can introduce security vulnerabilities. Is your AI coding agent implementation introducing security vulnerabilities?
8+
9+
[Project CodeGuard](https://github.com/project-codeguard/rules) solves this by embedding security best practices directly into AI coding agent workflows.
10+
11+
👉 Access the [Project CodeGuard Rules here](https://github.com/project-codeguard/rules)
12+
13+
## Before, During, and After Code Generation
14+
15+
[Project CodeGuard](https://github.com/project-codeguard/rules) 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.
16+
17+
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.
18+
19+
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.
20+

0 commit comments

Comments
 (0)