You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/develop/using-ai.md
-19Lines changed: 0 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -126,23 +126,4 @@ Your goal is to verify your control works correctly end-to-end.
126
126
3. Make any necessary adjustments and retest until everything works perfectly.
127
127
```
128
128
129
-
## Best Practices
130
-
131
-
1.**Start Small**: Begin with simple controls and gradually add complexity as needed.
132
-
2.**Test Thoroughly**: Always test your query independently before implementing the control.
133
-
3.**Follow Patterns**: Stick to established conventions from existing controls.
134
-
4.**Document Clearly**: Write documentation that helps users understand both what the control does and why it's important.
135
-
5.**Consider Performance**: Optimize queries for large-scale environments.
136
-
6.**Use Variables**: Make controls flexible with variables, but keep defaults sensible.
137
-
7.**Think Modular**: Design controls that can be reused across different benchmarks.
138
-
139
-
## Common Pitfalls to Avoid
140
-
141
-
1.**Overly Complex Queries**: Keep queries focused and simple when possible.
142
-
2.**Missing Edge Cases**: Test with various resource configurations.
143
-
3.**Hardcoded Values**: Use variables for configurable thresholds.
144
-
4.**Incomplete Documentation**: Always include examples and remediation steps.
145
-
5.**Inconsistent Naming**: Follow established naming patterns.
146
-
6.**Poor Error Handling**: Consider and handle potential error conditions.
147
-
148
129
Remember that AI tools work best when they can see the full context of your mod repository. Always open the entire repository in your IDE and use the Powerpipe MCP server when available for the most efficient development experience.
0 commit comments