docs: add agent coding standards#81
Open
Tootam wants to merge 1 commit into
Open
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
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.
ELI5
This PR adds small "read this first" notes for future coding agents working in this repo.
The root
AGENTS.mdexplains the shared project rules. Each important folder also gets its ownAGENTS.mdwith local guidance, for example backend safety rules, frontend Vue conventions, static asset handling, and style rules.Think of these files like labels on workshop drawers: before changing something, an agent can quickly see what belongs there, what patterns to follow, and what not to touch accidentally.
Motivation
Agent-assisted changes are more reliable when the repository explains its expectations directly in the source tree. This project has several important local conventions:
Without scoped guidance, a future automated change can easily drift from these conventions or touch generated/runtime assets by mistake. These docs make the expected practices explicit and local to the directories where they matter.
What Changed
AGENTS.mdwith repository-wide coding standards and verification guidance.extra/AGENTS.mdfor build scripts, Docker helpers, demo/template files, and packaging utilities.Validation
AGENTS.md.deno fmt --checkwas not run becausedenois not available in this environment.