40 lines
1.5 KiB
Markdown
40 lines
1.5 KiB
Markdown
---
|
|
name: rules
|
|
description: Access and apply project coding rules and conventions from .factory/rules/ directory. Use when needing to follow coding standards, conventions, or guidelines for the project.
|
|
user-invokable: false
|
|
disable-model-invocation: false
|
|
---
|
|
|
|
# Rules Skill
|
|
|
|
This skill provides access to project-specific coding rules and conventions stored in `.factory/rules/`.
|
|
|
|
## Available Rule Files
|
|
|
|
- **code.md** - General coding conventions and best practices
|
|
- **github.md** - GitHub-specific workflows and conventions
|
|
- **markdown.md** - Markdown formatting rules
|
|
- **project.md** - Project-specific conventions
|
|
- **python.md** - Python-specific coding standards
|
|
- **subagents.md** - Guidelines for using subagents
|
|
|
|
## When to use this skill
|
|
|
|
- When starting work on a new task to understand project conventions
|
|
- When unsure about coding standards for a specific language or context
|
|
- When setting up new code that should follow existing patterns
|
|
|
|
## Usage
|
|
|
|
Read the rule files from `.factory/rules/` and apply them as needed.
|
|
|
|
### ColGREP Init
|
|
|
|
When starting work on a project, run `colgrep init` to build the semantic search index. This enables the colgrep skill for semantic code search across the codebase. The index auto-updates on subsequent searches, so `init` only needs to run once per project.
|
|
|
|
## Research
|
|
|
|
- Back all claims with reference code.
|
|
- State only what is proven.
|
|
- If evidence is lacking, say: "I can't find any evidence to support this claim" or "Not enough info".
|