Add Agent Playbook section to README - #293
Conversation
Up to standards ✅🟢 Issues
|
![codacy-production[bot]](https://avatars.githubusercontent.com/in/56611?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull Request Overview
The added Agent Playbook contains critical procedural documentation but introduces direct contradictions with legacy sections of the README. Specifically, legacy instructions for manual file edits conflict with the new automation-focused guidance. There is also a syntax error in an sbt command string that requires correction to ensure successful local execution.
TIP Improve review quality by adding custom instructions
TIP How was this review? Give us feedback
| We use the [codacy-plugins-test](https://github.com/codacy/codacy-plugins-test) to test our external tools integration. | ||
| You can follow the instructions there to make sure your tool is working as expected. | ||
|
|
||
| ## Agent Playbook: Updating This Repository End-to-End |
There was a problem hiding this comment.
🟡 MEDIUM RISK
The documentation in the new 'Agent Playbook' contradicts legacy instructions in the 'Generate Docs' section (lines 24-37), particularly regarding manual edits to docs/patterns.json. To prevent conflicting guidance, remove the legacy sections and consolidate the documentation into the new playbook.
|
|
||
| 1. **Bump `pylint==` (and compatible companion packages)** in `requirements.txt`, and the base image tag in `Dockerfile` if warranted. | ||
| 2. **Regenerate the docs.** Requires `pandoc` on `PATH` and network access: `sbt "doc-generator/run"`. This overwrites `docs/patterns.json` and `docs/description/*`; review the diff for new/removed/renamed rules, changed defaults, and stale fixtures under `docs/tests/`/`docs/multiple-tests/`. | ||
| 3. **Format/compile the Scala doc-generator** if you touched `Main.scala`: `sbt "scalafmt::test; sbt:scalafmt::test"` (CI job `check_scalafmt` runs this). |
There was a problem hiding this comment.
🟡 MEDIUM RISK
Suggestion: To execute multiple sbt tasks in one command from the terminal, the string needs a leading semicolon (e.g., sbt ";task1; task2"). Without it, sbt interprets the entire string as a single command name.
2 participants
Summary
Test plan