docs: add documentation/rules for use with local Agent to write better explainers, work breakdown structures, and implementation of WBS by rjmurillo · Pull Request #638 · rjmurillo/moq.analyzers

rjmurillo · 2025-07-27T18:27:01Z

Summary by CodeRabbit

Documentation
- Added detailed guidelines for generating Explainers/PRDs, creating and managing task lists, and structuring related GitHub issues.
- Introduced strict task completion protocols for AI assistant workflows to ensure consistent progress tracking and quality control.
- Updated contribution and project instructions to require stricter build and test commands, including pedantic build mode and custom test settings.
Chores
- Enhanced process documentation to support junior developer onboarding and workflow clarity.

…cument (PRD)

… in Explainer/PRD generation

coderabbitai · 2025-07-27T18:27:11Z

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

This change introduces new procedural documentation and updates to existing instructions for generating Explainers/PRDs, creating and managing task lists, and enforcing stricter build and test protocols. The updates span new rule documents, enhancements to Copilot and project instructions, and expanded contributing guidelines, focusing on process clarity and workflow rigor.

Changes

Cohort / File(s)	Change Summary
`.cursor/rules/create-explainer.md`, `.cursor/rules/generate-tasks.md`, `.cursor/rules/process-task-list.md`	Adds new rule documents detailing protocols for generating Explainers/PRDs, task lists, and managing task completion in Markdown.
`.github/copilot-instructions.md`	Adds a section formalizing task list management, completion protocol, and AI agent compliance for Copilot and local agent workflows.
`.github/instructions/project.instructions.md`, `CONTRIBUTING.md`	Updates build and test commands for stricter validation, expands contributing principles, clarifies workflow, and improves formatting.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant AI Agent
    participant GitHub Issues

    User->>AI Agent: Request Explainer/PRD generation
    AI Agent->>User: Ask clarifying questions
    User->>AI Agent: Provide clarifications
    AI Agent->>GitHub Issues: Create Explainer/PRD issue

    User->>AI Agent: Request task list from Explainer/PRD
    AI Agent->>GitHub Issues: Analyze Explainer/PRD
    AI Agent->>User: Propose parent tasks, await confirmation
    User->>AI Agent: Confirm or revise tasks
    AI Agent->>GitHub Issues: Create parent and sub-task issues

    loop For each sub-task
        AI Agent->>User: Await approval to start sub-task
        User->>AI Agent: Approve sub-task
        AI Agent->>GitHub Issues: Mark sub-task in progress
        AI Agent->>GitHub Issues: Complete sub-task, mark as done
        AI Agent->>User: Pause for next approval
    end

    AI Agent->>GitHub Issues: Upon all sub-tasks complete, run tests, commit, mark parent task done

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Suggested reviewers

MattKotsenas

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e8f0a07 and 72e044e.

📒 Files selected for processing (6)

.cursor/rules/create-explainer.md (1 hunks)
.cursor/rules/generate-tasks.md (1 hunks)
.cursor/rules/process-task-list.md (1 hunks)
.github/copilot-instructions.md (1 hunks)
.github/instructions/project.instructions.md (1 hunks)
CONTRIBUTING.md (17 hunks)

✨ Finishing Touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch docs/ai-tasks

🪧 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.
- @coderabbitai modularize this function.
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.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

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

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

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.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

…cument (PRD)

… in Explainer/PRD generation

…yzers into docs/ai-tasks

codacy-production · 2025-07-27T18:29:59Z

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
✅ +0.00% (target: -1.00%)	✅ ∅ (target: 95.00%)

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (`e8f0a07`)	1830	1632	89.18%
Head commit (`72e044e`)	1830 (+0)	1632 (+0)	89.18% (+0.00%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#638)	0	0	∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings Change summary preferences

coderabbitai

Actionable comments posted: 5

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e8f0a07 and da09944.

📒 Files selected for processing (5)

.cursor/rules/create-explainer.md (1 hunks)
.cursor/rules/generate-tasks.md (1 hunks)
.cursor/rules/process-task-list.md (1 hunks)
.github/instructions/project.instructions.md (1 hunks)
CONTRIBUTING.md (1 hunks)

🧰 Additional context used

📓 Path-based instructions (3)

**/*.md

📄 CodeRabbit Inference Engine (CONTRIBUTING.md)

All documentation and markdown reports must pass formatting checks. Use a markdown linter if available.

Files:

CONTRIBUTING.md

**/CONTRIBUTING.md

📄 CodeRabbit Inference Engine (CONTRIBUTING.md)

Update contributing guidelines for workflow changes.

Files:

CONTRIBUTING.md

.github/instructions/*

📄 CodeRabbit Inference Engine (.github/copilot-instructions.md)

Update all relevant instruction files in .github/instructions/ when updating guidance

Files:

.github/instructions/project.instructions.md

🧠 Learnings (6)

📓 Common learnings

Learnt from: CR
PR: rjmurillo/moq.analyzers#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-07-27T02:44:39.596Z
Learning: Applies to {docs/rules/**,README.md} : Always update documentation for new features, API changes, or workflow/process changes

Learnt from: CR
PR: rjmurillo/moq.analyzers#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-07-27T02:44:39.596Z
Learning: Applies to {README.md,docs/rules/README.md} : Update README.md and docs/rules/README.md if workflows or rules change

Learnt from: CR
PR: rjmurillo/moq.analyzers#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-07-27T02:44:39.596Z
Learning: Applies to {docs/rules/**,README.md} : Update docs/rules/ and README.md if you add or change any analyzer, code fix, or workflow

Learnt from: CR
PR: rjmurillo/moq.analyzers#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-07-27T02:44:39.596Z
Learning: Applies to {src/Analyzers/AnalyzerReleases.Unshipped.md,docs/rules/**} : Update src/Analyzers/AnalyzerReleases.Unshipped.md and add or update documentation in docs/rules/ for each diagnostic

Learnt from: CR
PR: rjmurillo/moq.analyzers#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-07-27T02:44:39.596Z
Learning: Applies to {docs/rules/**,README.md} : Update docs/rules/ and README.md for any analyzer, code fix, or workflow change

Learnt from: CR
PR: rjmurillo/moq.analyzers#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-25T12:42:47.110Z
Learning: If adding an analyzer, also add a code fix, a benchmark, and documentation in 'docs/rules'.

Learnt from: CR
PR: rjmurillo/moq.analyzers#0
File: CONTRIBUTING.md:0-0
Timestamp: 2025-07-27T02:45:02.136Z
Learning: Applies to docs/rules/**/*.md : Update 'docs/rules/' for analyzer changes.

Learnt from: CR
PR: rjmurillo/moq.analyzers#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-25T12:42:47.111Z
Learning: Always check for and follow any new rules in .cursor/rules/, .editorconfig, and .github/copilot-instructions.md before making changes.

Learnt from: CR
PR: rjmurillo/moq.analyzers#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-25T12:42:47.110Z
Learning: Reference affected analyzer rule IDs in PR descriptions.

Learnt from: CR
PR: rjmurillo/moq.analyzers#0
File: CONTRIBUTING.md:0-0
Timestamp: 2025-07-27T02:45:02.136Z
Learning: Applies to **/CONTRIBUTING.md : Update contributing guidelines for workflow changes.

Learnt from: CR
PR: rjmurillo/moq.analyzers#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-25T12:42:47.110Z
Learning: If changing an analyzer, update documentation in 'docs/rules' to reflect all changes.

CONTRIBUTING.md (16)

Learnt from: CR
PR: rjmurillo/moq.analyzers#0
File: CONTRIBUTING.md:0-0
Timestamp: 2025-07-27T02:45:02.136Z
Learning: Applies to **/*.{cs,csproj,sln} : Build with 'dotnet build /p:PedanticMode=true'. All warnings must be treated as errors. PRs that do not build cleanly will be closed.

Learnt from: CR
PR: rjmurillo/moq.analyzers#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-25T12:42:47.110Z
Learning: Build with warnings as errors using 'dotnet build /p:PedanticMode=true'.

Learnt from: CR
PR: rjmurillo/moq.analyzers#0
File: CONTRIBUTING.md:0-0
Timestamp: 2025-07-27T02:45:02.136Z
Learning: Applies to **/CONTRIBUTING.md : Update contributing guidelines for workflow changes.

Learnt from: CR
PR: rjmurillo/moq.analyzers#0
File: CONTRIBUTING.md:0-0
Timestamp: 2025-07-27T02:45:02.136Z
Learning: Applies to **/*.{cs} : Run 'dotnet format' and commit all changes before submitting a pull request. PRs with formatting issues will be rejected.

Learnt from: CR
PR: rjmurillo/moq.analyzers#0
File: CONTRIBUTING.md:0-0
Timestamp: 2025-07-27T02:45:02.136Z
Learning: Applies to **/*.{cs} : Run Codacy CLI analysis on all changed files and fix all reported issues before submitting the PR.

Learnt from: CR
PR: rjmurillo/moq.analyzers#0
File: CONTRIBUTING.md:0-0
Timestamp: 2025-07-27T02:45:02.136Z
Learning: Applies to README.md : Update README for significant changes.

Learnt from: CR
PR: rjmurillo/moq.analyzers#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-07-27T02:44:39.596Z
Learning: Applies to {docs/rules/**,README.md} : Update docs/rules/ and README.md for any analyzer, code fix, or workflow change

Learnt from: CR
PR: rjmurillo/moq.analyzers#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-25T12:42:47.110Z
Learning: Summarize all changes in the PR description and cite relevant lines from modified files for clarity.

Learnt from: CR
PR: rjmurillo/moq.analyzers#0
File: CONTRIBUTING.md:0-0
Timestamp: 2025-07-27T02:45:02.136Z
Learning: Applies to tests/Moq.Analyzers.Benchmarks/**/*.cs : Performance-sensitive changes require benchmark validation. Run performance tests locally before submitting PRs and include performance regression analysis in PR description.

Learnt from: CR
PR: rjmurillo/moq.analyzers#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-07-27T02:44:39.596Z
Learning: Applies to tests/Moq.Analyzers.Test/**/*.cs : Add or update unit tests in tests/Moq.Analyzers.Test/ for every analyzer or code fix change

Learnt from: CR
PR: rjmurillo/moq.analyzers#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-25T12:42:47.110Z
Learning: Every pull request must include evidence of running code formatting, building with warnings as errors, and running all unit tests (console log/text or screenshots) in the PR description.

Learnt from: CR
PR: rjmurillo/moq.analyzers#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-25T12:42:47.111Z
Learning: Re-run dotnet format, build, and tests after resolving feedback or merge conflicts.

Learnt from: CR
PR: rjmurillo/moq.analyzers#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-25T12:42:47.111Z
Learning: When making changes, follow the workflow: Edit/Add Code or Test → Run codacy_cli_analyze → Fix issues if any → Run/Update Tests → Fix test failures if any → Update Docs → Commit & PR.

Learnt from: CR
PR: rjmurillo/moq.analyzers#0
File: CONTRIBUTING.md:0-0
Timestamp: 2025-07-27T02:45:02.136Z
Learning: Applies to tests/**/*.cs : Run all unit tests using 'dotnet test --settings ./build/targets/tests/test.runsettings'. All tests must pass.

Learnt from: CR
PR: rjmurillo/moq.analyzers#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-07-27T02:44:39.596Z
Learning: Run dotnet test (all must pass)

Learnt from: CR
PR: rjmurillo/moq.analyzers#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-06-25T12:42:47.111Z
Learning: Ensure all changes are covered by tests and documentation before committing.

.github/instructions/project.instructions.md (14)