Update AI Agent instructions - #99
Conversation
|
Caution Review failedThe pull request is closed. Summary by CodeRabbit
WalkthroughRepository governance and review configuration were overhauled: Changes
Sequence Diagram(s)(Skipped — changes are documentation and config-focused; no control-flow feature added that requires a sequence diagram.) Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (16)
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
🎉 Snyk checks have passed. No issues have been found so far.✅ security/snyk check is complete. No issues have been found. (View Details) ✅ code/snyk check is complete. No issues have been found. (View Details) |
…istency - Deleted outdated rules files: `commit-style.mdc`, `compliance-standards.mdc`, `project-structure.mdc`. - Introduced new `INDEX.md` for quick reference to Cursor rules and their organization. - Added comprehensive documentation for AI assistant guidelines and development workflow. - Established clear project structure and requirements management guidelines to enhance maintainability. All tests passed successfully; no tests were affected by these changes.
- Added comprehensive sections on rule precedence, project overview, core philosophy, technology stack, and coding standards. - Included detailed guidelines for AI assistant behavior, development process, and mandatory practices for AI agents. - Enhanced documentation to clarify project-specific conventions and CI/CD integration standards. All tests passed successfully; no tests were affected by these changes.
…gration standards - Added a new section detailing EvilBit Labs brand principles emphasizing trust, quality, and ethical constraints. - Updated CI/CD integration standards to include commit message formats, quality gates, and development commands. - Enhanced AI assistant guidelines with clear rules of engagement and code generation requirements. All tests passed successfully; no tests were affected by these changes.
… documentation - Revised tone instructions to focus on OPNsense XML parsing, markdown generation, and audit compliance. - Disabled free tier access for improved control and security. - Updated review profile to assertive and added detailed labeling instructions for issue categorization. All tests passed successfully; no tests were affected by these changes.
- Introduced `HybridGenerator` to support both programmatic and template-based markdown generation, allowing for gradual migration. - Added `generateWithHybridGenerator` function to streamline output generation based on user-defined options. - Updated command flags to enhance custom template functionality. - Created comprehensive tests to validate output consistency between programmatic and template generation modes. All tests passed successfully; no tests were affected by these changes.
…st coverage - Introduced a caching mechanism for template loading to optimize IO/CPU operations, reducing redundant template parsing. - Added comprehensive tests for `getCachedTemplate` to validate caching behavior and error handling for various scenarios. - Enhanced command flags to support filename completion for custom templates, improving user experience. - Updated existing tests to ensure compatibility with the new caching functionality. All tests passed successfully; no tests were affected by these changes.
46c3338 to
a16ba5b
Compare
This pull request introduces significant improvements to project documentation, rule organization, and review configuration. The changes focus on clarifying and structuring development standards, especially for AI assistants and plugin architecture, and enhance the review process with more detailed labeling instructions. The most important changes are grouped below by theme.
Documentation and Rule Organization:
.cursor/rules/INDEX.mdand a comprehensive.cursor/rules/README.mdto provide a clear overview of rule categories, folder structure, rule precedence, and application guidelines for the project. This makes it easier for contributors to find and understand applicable rules. [1] [2].cursor/rules/ai-assistant/ai-assistant-guidelines.mdcwith explicit rules for AI assistant behavior, code generation, development workflows, and mandatory practices, ensuring consistent and high-quality AI contributions.plugin-architecture.mdcinto thearchitecture/folder with explicit glob patterns, and clarified mandatory practices indevelopment-workflow.mdc(now underai-assistant/). [1] [2].cursor/rules/commit-style.mdcfile, centralizing commit message standards in the new documentation structure.Review and Workflow Configuration:
.coderabbit.yamlto refine tone instructions (emphasizing OPNsense XML parsing, markdown quality, audit compliance), disable the free tier, set the review profile to "assertive," and add detailed labeling instructions for PR categorization (e.g., feature, bug, priority, audit, documentation, etc.). This improves review clarity and workflow management. [1] [2]These changes collectively improve project maintainability, onboarding, and quality assurance by making standards and workflows more discoverable and actionable.