docs(agents): Add Development Environment & Build section to AGENTS.md#73
Conversation
Co-authored-by: Krzysztof Ploch <kploch@users.noreply.github.com>
📝 WalkthroughWalkthroughThe PR adds a "Development Environment & Build" section to Build and Development Environment Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds a 'Cursor Cloud specific instructions' section to AGENTS.md, providing an overview of the Ploch.Data library, required sibling repositories, and standardized build, test, and run commands. The review feedback suggests including the -p:UsePlochProjectReferences=true property in the dotnet run command for consistency and updating the 'No global.json' heading to accurately reflect that the file exists but is not used for SDK pinning.
|
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Up to standards ✅🟢 Issues
|
The section added by #73 was scoped "Cursor Cloud specific instructions", but its content — library overview, sibling-repo setup, build/test/run commands and build gotchas — applies to any agent or contributor. Rename it to "Development Environment & Build" and move the genuinely Cursor-Cloud-specific note into its own subsection. Correct three inaccuracies found while reviewing the section: - Remove the "repository contains a global.json file" claim; the repo has no global.json. The bullet now states the SDK is not pinned. - Remove the MSB4011 "Ploch.Packages.props imported twice" gotcha; a verbose solution build emits zero MSB4011 warnings and the file is imported once. - Clarify that UsePlochProjectReferences switches the SampleApp from PackageReference to ProjectReference; it is not a Debug-mode or repo-wide package-resolution switch. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Qodo reviews are paused for this user.Troubleshooting steps vary by plan Learn more → On a Teams plan? Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center? |
kploch
changed the title
Reviewer's GuideAdds a Development Environment & Build section to AGENTS.md documenting how to set up and build Ploch.Data (including sibling repo requirements, project reference usage, and Cursor Cloud background agent behavior). File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - I've found 1 issue
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path="AGENTS.md" line_range="827" />
<code_context>
+
+### Cursor Cloud background agents
+
+Cursor Cloud background agents provision the workspace with an environment update script (configured in Cursor, not committed to this repo). It clones the sibling repositories listed above, runs `git fetch --unshallow` on `ploch-common`, and installs the .NET 8.0 and 10.0 SDKs.
</code_context>
<issue_to_address>
**issue (typo):** Fix plural/singular mismatch between “background agents” and “It clones…”.
The subject is plural (“Cursor Cloud background agents”), but the next sentence uses a singular pronoun (“It clones…”). Please make them agree, e.g. change to “They clone the sibling repositories…” or make the subject singular.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Attach the cloning/SDK-install clause directly to "environment update script" with a relative clause, removing the singular "It" that read as a mismatch with the plural "background agents" subject. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
CodeAnt AI is reviewing your PR. Thanks for using CodeAnt! 🎉We're free for open-source projects. if you're enjoying it, help us grow by sharing. Share on X · |
codeant-ai
Bot
added
the
size:M
|
CodeAnt AI finished reviewing your PR. |
|
|
Bito Automatic Review Skipped – PR Already Merged |
2 participants
User description
Describe your changes
Adds a Development Environment & Build section to
AGENTS.mddocumenting how any agent or contributor builds the repository — locally, in CI, or in a cloud sandbox.net8.0+net10.0; libraries + SampleApp demo, no server)mrploch-development,ploch-common) and the Nerdbank.GitVersioning shallow-clone constraint-p:UsePlochProjectReferences=trueglobal.json, GitHub Packages auth)Design decisions
The section was originally titled "Cursor Cloud specific instructions", but its content is generic repo knowledge that applies to every agent and contributor —
AGENTS.mdis the agent-agnostic instructions file. It has been generalised to "Development Environment & Build", and the one truly Cursor-specific detail demoted to a subsection.Three factual inaccuracies were found and corrected during review:
global.json— removed the claim that the repository contains aglobal.jsonfile; it does not. The bullet now states the SDK is not pinned.dotnet build -v:normal) emits zero MSB4011 warnings andPloch.Packages.propsis imported once.UsePlochProjectReferences— clarified that this flag switches the SampleApp fromPackageReferencetoProjectReference; it is not a Debug-mode or repo-wide package-resolution switch.Testing
dotnet restore+dotnet build ./Ploch.Data.slnx -p:UsePlochProjectReferences=truecomplete successfully (exit 0), verifying the documented commands. Docs-only change — no code paths affected.Issue ticket number and link
N/A — development environment documentation.
Checklist before requesting a review
Summary by Sourcery
Document development environment and build setup requirements for contributors and cloud agents working with the Ploch.Data repository.
Documentation:
Summary by CodeRabbit
CodeAnt-AI Description
Document how to build, test, and run the repository from a local, CI, or cloud workspace
What Changed
ploch-commonImpact
✅ Faster first-time setup✅ Fewer build failures from missing repo dependencies✅ Clearer local and cloud build instructions💡 Usage Guide
Checking Your Pull Request
Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.
Talking to CodeAnt AI
Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:
This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.
Example
Preserve Org Learnings with CodeAnt
You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:
This helps CodeAnt AI learn and adapt to your team's coding style and standards.
Example
Retrigger review
Ask CodeAnt AI to review the PR again, by typing:
Check Your Repository Health
To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.