alexion/dev
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(repo): add technical writing guide

Browse Source
This commit is contained in:
alexion
2026-08-30 08:30:34 -04:00
parent d05bb4857e
commit b9f8f6a626
3 changed files with 153 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
AGENTS.md
View File

@@ -3,9 +3,14 @@
## Commit convention
Use Conventional Commits for all commit messages.
Before writing a commit message, please read [[docs/conventional-commits]].
Before writing a commit message, read `docs/conventional-commits.md`.
Do not add agent attribution or co-author trailers.
## Technical writing
Use `docs/technical-writing.md` and `docs/dictionary.md` for authored prose.
Use the nearest project dictionary for project-specific domain language.
## Gotchas
- When materializing an external specification, standard, or project-maintained convention, use the upstream source instead of reconstructing it from memory.