Coding Assistant Instructions for a Team Repository
Align an assistant with project conventions.
The Open buttons send the prompt text as currently shown below to that site only when you click. Fill in the placeholders first.
Write instructions for a coding assistant used on our repository. Languages, frameworks, and versions: [STACK]. Conventions (formatting, naming, architecture, testing, commit messages): [CONVENTIONS]. Security and compliance rules: [SECURITY_RULES]. Commands to run tests, lint, and build: [COMMANDS]. Areas that need extra care: [SENSITIVE_AREAS]. Produce an instruction document with sections: project overview in 100 words; directory map; coding standards with examples of right and wrong; testing rules (write or update tests with every change, tests must pass, how to run them); security rules (never write secrets into code or logs, validate input, parameterize queries, follow the dependency policy, no new dependencies without justification); change process (small diffs, explain the reasoning, list files changed, note risks); things the assistant must ask a human before doing (schema changes, deleting data, changing authentication, touching deployment configs); how to respond when requirements are unclear; and what not to do (reformatting unrelated files, inventing APIs, claiming tests passed without running them). Add a pull request description template the assistant should fill, a list of ten test prompts to validate behavior, and a review process: all assistant-written code gets human review. Explain that the assistant may ignore instructions sometimes and tools can enforce rules (linters, CI).
Fill in before use
Optional: type your details and the prompt above updates. Nothing is saved or sent.
Replace each bracketed placeholder with your own details, then paste into Any AI or another assistant.