Skip to content

Update README Terminology: "Rules" → "Skills and Rules" #93

@santosomar

Description

@santosomar

The README.md currently uses inconsistent terminology, sometimes referring to "rules" and sometimes to "skills and rules". Since Project CodeGuard provides both skills (agent-specific capabilities) and rules (security guidelines), the documentation should consistently reflect this dual nature.

Proposed Solution

Update all references throughout README.md to use "skills and rules" terminology consistently, ensuring users understand that Project CodeGuard offers both types of resources.

Specific Changes Needed

  1. Update main title from "Security Rules" to "Security Skills and Rules"
  2. Replace standalone references to "rules" with "skills and rules" throughout:
    • "Before code generation" section
    • "During code generation" section
    • "Security Coverage" section
    • "Quick Start" section
    • "How It Works" section
  3. Update copyright year from 2025 to 2026
  4. Remove emoji from "Licensing" section header for consistency
  5. Fix typo: "skills andrules" → "skills and rules"

Benefits

  • Clarity: Users will better understand that Project CodeGuard provides both skills and rules
  • Consistency: Documentation will use consistent terminology throughout
  • Accuracy: Reflects the actual structure and offerings of the project

Related

This is a documentation improvement that aligns with the project's dual offering of skills and rules.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions