1.6 KiB
1.6 KiB
Repository Guidelines
Project Structure & Module Organization
- Documentation lives in the repository root as Markdown files (
index.md,prehist.md,compilers.md,hopes.md). - Original Russian sources are stored in
ru/with the same filenames. - Other files (e.g.,
t(cdr(J),K,diff(K))) should be treated as historical artifacts; do not rename or remove unless explicitly requested.
Build, Test, and Development Commands
- No build or test tooling is defined in this repo.
- Use standard Markdown tooling if you need previews (e.g.,
pandocor a local Markdown viewer), but do not introduce new build scripts without discussion.
Coding Style & Naming Conventions
- Keep content in Markdown with clear headings and stable anchor links.
- Preserve filenames and the document order when translating or editing.
- Maintain a consistent tone with existing narrative prose; avoid adding extra section headers unless necessary.
- Keep line wrapping consistent with the file you edit (current files are mostly long lines).
Testing Guidelines
- No automated tests are present.
- Validate changes by checking internal links and anchors in the modified Markdown files.
Commit & Pull Request Guidelines
- Commit messages in history are short and lowercase (e.g.,
dec. upd.,citations). Follow that pattern. - PRs should describe which documents changed and why, and call out any renamed headings or anchor changes.
Translation Notes
- English translations live in the repo root; Russian originals stay under
ru/. - When translating headings, update the TOC entries to match the new anchor text.