Skip to content

Update AI Agent instructions - #99

Merged
unclesp1d3r merged 6 commits into
mainfrom
85-phase-2-implement-smart-migration-path-with-hybrid-generator
Aug 11, 2025
Merged

Update AI Agent instructions#99
unclesp1d3r merged 6 commits into
mainfrom
85-phase-2-implement-smart-migration-path-with-hybrid-generator

Conversation

@unclesp1d3r

Copy link
Copy Markdown
Member

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:

  • Added .cursor/rules/INDEX.md and a comprehensive .cursor/rules/README.md to 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]
  • Introduced .cursor/rules/ai-assistant/ai-assistant-guidelines.mdc with explicit rules for AI assistant behavior, code generation, development workflows, and mandatory practices, ensuring consistent and high-quality AI contributions.
  • Updated and reorganized plugin and development workflow rules: moved plugin-architecture.mdc into the architecture/ folder with explicit glob patterns, and clarified mandatory practices in development-workflow.mdc (now under ai-assistant/). [1] [2]
  • Removed the old .cursor/rules/commit-style.mdc file, centralizing commit message standards in the new documentation structure.

Review and Workflow Configuration:

  • Updated .coderabbit.yaml to 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.

@coderabbitai

coderabbitai Bot commented Aug 11, 2025

Copy link
Copy Markdown
Contributor

Caution

Review failed

The pull request is closed.

Summary by CodeRabbit

  • Documentation
    • Added comprehensive contributor and AI assistant guidelines, CI/CD standards, commit message policy, and project structure guide.
    • Introduced rules index and README for easier navigation; expanded brand principles and technology guidance.
    • Clarified development workflows, commands, testing expectations, and usage examples.
  • Chores
    • Updated review automation settings, labels, and pre-merge checks; enabled auto reviews and finishing touches.
    • Adjusted configuration tone and reviewer profile; free tier disabled.
  • Style
    • Minor formatting and emphasis improvements.
  • Revert
    • Removed outdated compliance and project structure documents.

Walkthrough

Repository governance and review configuration were overhauled: .coderabbit.yaml expanded with assertive review controls and labeling; many .cursor/rules/* documentation files were added, reorganized, or removed; AGENTS/Copilot guidance expanded. No executable code or API signatures changed.

Changes

Cohort / File(s) Summary
Review config
/.coderabbit.yaml
Replaced free-tier=true with false; switched reviews.profile to "assertive"; added high_level_summary_in_walkthrough, auto_title_placeholder/instructions, many review toggles (review_status, commit_status, changed_files_summary, sequence_diagrams, estimate_code_review_effort, related_issues/PRs, suggested_labels/auto_apply_labels, suggested_reviewers/auto_assign_reviewers, collapse_walkthrough, fail_commit_status); added labeling_instructions (13-item schema), disable_cache, auto_review, finishing_touches, pre_merge_checks; removed poem.
Cursor rules index & overview
.cursor/rules/INDEX.md, .cursor/rules/README.md
Added INDEX navigational file and README describing rule folders, precedence, always-applied rules, glob mappings, and maintenance guidance.
AI assistant rules & workflow
.cursor/rules/ai-assistant/ai-assistant-guidelines.mdc, .cursor/rules/ai-assistant/development-workflow.mdc
Added comprehensive AI Assistant guidelines with mandatory practices, workflows, commands, tooling, and developer expectations; minor typographic emphasis change to "MUST" in development-workflow.
Core rules & concepts
.cursor/rules/core/commit-style.mdc, .cursor/rules/core/core-concepts.mdc
Added new core commit-style policy enforcing Conventional Commits with required scopes; added EvilBit Labs Brand Principles and changed logging recommendation to charmbracelet/log.
Project structure (moved/added/removed)
.cursor/rules/project/project-structure.mdc, .cursor/rules/project-structure.mdc
Added canonical project structure under project/; removed legacy top-level project-structure.mdc.
Quality / CI-CD
.cursor/rules/quality/ci-cd-standards.mdc
New CI/CD standards file: quality gates, mandatory checks, testing/coverage targets, race detection, release and docs validation standards.
Architecture rule tweak
.cursor/rules/architecture/plugin-architecture.mdc
Added YAML front matter with globs and removed three trailing bullets; core document otherwise unchanged.
Go testing rule
.cursor/rules/go/go-testing.mdc
Simplified front-matter globs from list to **/*.go; whitespace/formatting only.
Removed legacy rules
.cursor/rules/commit-style.mdc, .cursor/rules/compliance-standards.mdc
Deleted legacy commit-style and compliance-standards documents (content removed).
Copilot / agent docs
.github/copilot-instructions.md, AGENTS.md
Rewrote/expanded Copilot and AGENTS guidance with project overview, architecture, coding/testing/security standards, CI/CD, AI assistant governance, workflows, and checklists.
New rules index entries
.cursor/rules/* (various)
Many new or moved rule files added across core, ai-assistant, go, project, quality to centralize governance and ensure audit/CLI/documentation alignment.

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

In docs that map the parser's art,
Labels tidy every part.
Commits scoped neat, the CI sings,
Offline CLI and audit rings.
Rules align — governance in heart.


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 46c3338 and a16ba5b.

📒 Files selected for processing (16)
  • .coderabbit.yaml (2 hunks)
  • .cursor/rules/INDEX.md (1 hunks)
  • .cursor/rules/README.md (1 hunks)
  • .cursor/rules/ai-assistant/ai-assistant-guidelines.mdc (1 hunks)
  • .cursor/rules/ai-assistant/development-workflow.mdc (1 hunks)
  • .cursor/rules/architecture/plugin-architecture.mdc (1 hunks)
  • .cursor/rules/commit-style.mdc (0 hunks)
  • .cursor/rules/compliance-standards.mdc (0 hunks)
  • .cursor/rules/core/commit-style.mdc (1 hunks)
  • .cursor/rules/core/core-concepts.mdc (2 hunks)
  • .cursor/rules/go/go-testing.mdc (8 hunks)
  • .cursor/rules/project-structure.mdc (0 hunks)
  • .cursor/rules/project/project-structure.mdc (1 hunks)
  • .cursor/rules/quality/ci-cd-standards.mdc (1 hunks)
  • .github/copilot-instructions.md (4 hunks)
  • AGENTS.md (5 hunks)
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch 85-phase-2-implement-smart-migration-path-with-hybrid-generator

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@unclesp1d3r

unclesp1d3r commented Aug 11, 2025

Copy link
Copy Markdown
Member Author

🎉 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)

@coderabbitai coderabbitai Bot added the documentation Improvements or additions to documentation label Aug 11, 2025
…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.
@unclesp1d3r
unclesp1d3r force-pushed the 85-phase-2-implement-smart-migration-path-with-hybrid-generator branch from 46c3338 to a16ba5b Compare August 11, 2025 05:32
@unclesp1d3r
unclesp1d3r enabled auto-merge (rebase) August 11, 2025 05:32
@unclesp1d3r
unclesp1d3r merged commit d7da710 into main Aug 11, 2025
11 of 14 checks passed
@unclesp1d3r
unclesp1d3r deleted the 85-phase-2-implement-smart-migration-path-with-hybrid-generator branch August 11, 2025 05:33
@coderabbitai coderabbitai Bot added audit Phase 4.3 tasks - Audit Report Generation priority:normal Normal priority issue labels Aug 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

audit Phase 4.3 tasks - Audit Report Generation documentation Improvements or additions to documentation priority:normal Normal priority issue

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant