ai-rulez 1.1.0 → 1.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +22 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -144,6 +144,28 @@ The tool looks for configuration files in this order:
|
|
|
144
144
|
- `.ai_rulez.yaml`
|
|
145
145
|
- `ai_rulez.yaml`
|
|
146
146
|
|
|
147
|
+
### User Rules vs. Coding Rules
|
|
148
|
+
|
|
149
|
+
When creating AI rules, distinguish between two types of instructions:
|
|
150
|
+
|
|
151
|
+
- **Coding Rules**: Technical guidelines about code quality, architecture, testing, etc.
|
|
152
|
+
- Examples: "Use TypeScript strict mode", "Write unit tests", "Follow REST conventions"
|
|
153
|
+
- Should be in the main configuration file committed to version control
|
|
154
|
+
|
|
155
|
+
- **User Rules**: Personal preferences about communication style and interaction
|
|
156
|
+
- Examples: "Be concise in responses", "Use casual tone", "Address me as 'Chief'", "Always explain your reasoning"
|
|
157
|
+
- Perfect for `.local.yaml` files (e.g., `ai-rulez.local.yaml`) as they're personal and shouldn't affect the whole team
|
|
158
|
+
- Allow individual developers to customize AI behavior without impacting others
|
|
159
|
+
|
|
160
|
+
**Example local config** (`ai-rulez.local.yaml`):
|
|
161
|
+
```yaml
|
|
162
|
+
rules:
|
|
163
|
+
- name: "Communication Style"
|
|
164
|
+
content: "Be concise and direct. Address me as 'Boss'. Always ask for clarification before making assumptions."
|
|
165
|
+
- name: "Response Format"
|
|
166
|
+
content: "Provide code examples for every suggestion. Use bullet points for lists."
|
|
167
|
+
```
|
|
168
|
+
|
|
147
169
|
### Configuration Schema
|
|
148
170
|
|
|
149
171
|
```yaml
|
package/package.json
CHANGED