home-tools/bookshelf
1
0
Fork 0
Code Actions Packages Releases Activity

Update docs; add contributing standards

Browse Source 
- docs/overview.md: rewrite for current architecture (src/ layout,
  split JS/CSS modules, credentials/models/functions/ui config
  categories, correct test fixture targets)
- docs/contributing.md: new — documentation philosophy and style guide
- AGENTS.md: add rule to follow docs/contributing.md
This commit is contained in:
Пётр Полежаев
2026-03-09 14:22:30 +03:00
parent 084d1aebd5
commit 2ab41ead9f
3 changed files with 156 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
AGENTS.md
View File

@@ -8,3 +8,10 @@
## Implementation rules
- No backward-compatibility shims or legacy endpoint aliases.
- Run `poetry run presubmit` before finishing any task. Fix all failures before marking work done.
## Documentation rules
Follow `docs/contributing.md`. Key points:
- Prefer in-code comments and self-documenting code over external docs.
- Add docstrings only to public functions you create or modify; Google style.
- Update `docs/overview.md` only for structural/architectural changes, not implementation details.
- No emojis in any documentation.