docs(agents): add shared engineering guidance - #33
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
Require agents to read the shared reuse-first engineering guidance before project work.
Scope
Copy the supplied Engineering-Prompt.md into the project root. Add a first-line link to AGENTS.md and CLAUDE.md and preserve their existing content.
Verification
Passed skill synchronization and its regression cases, module tidy, formatting, go vet, golangci-lint, race tests, and build.
The prompt matches the supplied source byte-for-byte. Intentional Markdown hard-break spaces are preserved. Application behavior is unchanged.
The source and copies include a final newline for Markdown lint compatibility; the prompt wording is unchanged.
Note
Low Risk
Documentation-only changes to agent onboarding; no runtime or application behavior is modified.
Overview
Adds a shared reuse-first / ecosystem-first engineering prompt at the repo root (
Engineering-Prompt.md) and makes it the first required read for agents by linking it fromAGENTS.mdandCLAUDE.md(existing operating/project instructions and machine contract pointers are unchanged).The new doc mandates reconnaissance (codebase, dependencies/SDKs, ecosystem search, stdlib) before custom code, defines a preferred solution hierarchy ending in custom implementation as last resort, and requires a short reconnaissance summary for non-trivial work.
Reviewed by Cursor Bugbot for commit 70fd449. Bugbot is set up for automated code reviews on this repo. Configure here.