Skip to content

Commit 72bfdb5

Browse files
author
Ramraj Bishnoie
committed
chore: updated doc and SKILLS file to reflect correct rule count
1 parent 52489c7 commit 72bfdb5

2 files changed

Lines changed: 11 additions & 8 deletions

File tree

docs/claude-code-skill-plugin.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -70,14 +70,13 @@ When generating or reviewing code, Claude follows this 3-step workflow:
7070

7171
### Rule Categories
7272

73-
**Always-Apply Rules** (4 critical rules checked on every code operation):
73+
**Always-Apply Rules** (3 critical rules checked on every code operation):
7474
- `codeguard-1-hardcoded-credentials` - Never hardcode secrets or credentials
7575
- `codeguard-1-crypto-algorithms` - Use modern cryptographic algorithms
7676
- `codeguard-1-digital-certificates` - Validate certificate security
77-
- `codeguard-1-safe-c-functions` - Replace unsafe C/C++ functions
7877

79-
**Context-Specific Rules** (18 rules applied based on technology and features):
80-
- Input validation, authentication, authorization, APIs, data storage, privacy, logging, cryptography, file handling, serialization, supply chain, DevOps, cloud, Kubernetes, IaC, frameworks, and mobile security
78+
**Context-Specific Rules** (19 rules applied based on technology and features):
79+
- Input validation, authentication, authorization, APIs, data storage, privacy, logging, cryptography, file handling, serialization, supply chain, DevOps, cloud, Kubernetes, IaC, frameworks, mobile security, and memory safety (C/C++)
8180

8281
## Usage Examples
8382

@@ -155,7 +154,7 @@ For organizations, deploy CodeGuard to all developers automatically:
155154

156155
The plugin includes 22 comprehensive security rules organized into two categories:
157156

158-
### Always-Apply Rules (4 rules)
157+
### Always-Apply Rules (3 rules)
159158

160159
These critical rules are checked on **every** code operation:
161160

@@ -164,9 +163,8 @@ These critical rules are checked on **every** code operation:
164163
| `codeguard-1-hardcoded-credentials` | Prevent secrets, passwords, API keys, tokens in source code |
165164
| `codeguard-1-crypto-algorithms` | Ban weak algorithms (MD5, SHA-1, DES); use modern alternatives |
166165
| `codeguard-1-digital-certificates` | Validate certificate expiration, key strength, signature algorithms |
167-
| `codeguard-1-safe-c-functions` | Replace unsafe C/C++ functions (gets, strcpy, strcat, sprintf) |
168166

169-
### Context-Specific Rules (18 rules)
167+
### Context-Specific Rules (19 rules)
170168

171169
These rules apply based on the programming language, framework, or feature being implemented. Claude automatically selects relevant rules based on context:
172170

@@ -182,6 +180,7 @@ These rules apply based on the programming language, framework, or feature being
182180
| **Files & Serialization** | `codeguard-0-file-handling-and-uploads`, `codeguard-0-xml-and-serialization` |
183181
| **Infrastructure** | `codeguard-0-supply-chain-security`, `codeguard-0-devops-ci-cd-containers`, `codeguard-0-cloud-orchestration-kubernetes`, `codeguard-0-iac-security` |
184182
| **Platforms** | `codeguard-0-framework-and-languages`, `codeguard-0-mobile-apps` |
183+
| **Memory Safety (C/C++)** | `codeguard-0-safe-c-functions` |
185184

186185
> **Note:** Each rule file contains detailed guidance, checklists, and examples. Claude references these automatically based on the code context.
187186
@@ -385,6 +384,11 @@ Found an issue with the plugin or want to improve it?
385384

386385
## Version History
387386

387+
### Version 1.0.1
388+
- Changed `codeguard-1-safe-c-functions` from always-apply to `codeguard-0-safe-c-functions` context-specific rule (C/C++ only)
389+
- Updated rule counts: 3 always-apply rules, 19 context-specific rules
390+
- Fixed GitHub Copilot instructions to use `description` field instead of `title`
391+
388392
### Version 1.0.0
389393
- Initial release
390394
- 22 comprehensive security rules

sources/core/codeguard-SKILLS.md.template

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ When writing or reviewing code:
2424
- `codeguard-1-hardcoded-credentials.md` - Never hardcode secrets, passwords, API keys, or tokens
2525
- `codeguard-1-crypto-algorithms.md` - Use only modern, secure cryptographic algorithms
2626
- `codeguard-1-digital-certificates.md` - Validate and manage digital certificates securely
27-
- `codeguard-1-safe-c-functions.md` - Avoid unsafe C/C++ functions and use safe alternatives
2827
2. Context-Specific Rules: Apply rules from /rules directory based on the language of the feature being implemented using the table given below:
2928
<!-- LANGUAGE_MAPPINGS_START -->
3029
<!-- LANGUAGE_MAPPINGS_END -->

0 commit comments

Comments
 (0)