Honza/Dokumentace
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix documentation inconsistencies and bump document versions

Browse Source
This commit is contained in:
Jan Doubravský
2026-08-18 12:22:57 +02:00
parent 5c0f2f758f
commit b337da11a6
17 changed files with 170 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Rust/DESIGN_DOCUMENT.md
+2 -1
View File
@@ -1,6 +1,6 @@
# Rust Application Development Guidelines
**Document Version:** v1
**Document Version:** v2
> **Note on Versioning:**
> - This document version is independent — reused across projects
@@ -25,6 +25,7 @@ The root directory contains only the core documents: `README.md`, `AGENTS.md`, `
## 1. Code Style
- **Rust edition:** 2024 (requires Rust 1.85 or newer)
- **100-character lines** (rustfmt default `max_width`)
- Format with **rustfmt** — run `cargo fmt` before every commit
- Lint with **clippy** — run `cargo clippy -- -D warnings` before every commit
- **snake_case** functions/variables/modules, **PascalCase** types/traits, **SCREAMING_SNAKE_CASE** constants
Rust/DESIGN_DOCUMENT_LIB.md
+2 -3
View File
@@ -1,6 +1,6 @@
# Rust Library Development Guidelines
**Document Version:** v1
**Document Version:** v2
> **Note on Versioning:**
> - This document version is independent — reused across projects
@@ -28,6 +28,7 @@ The root directory contains only the core documents: `README.md`, `AGENTS.md`, `
- **Rust edition:** 2024 (requires Rust 1.85 or newer)
- Declare the minimum toolchain in `Cargo.toml` (`rust-version = "1.85"`) so consumers get a clear error instead of a compile failure
- **100-character lines** (rustfmt default `max_width`)
- Format with **rustfmt** — run `cargo fmt` before every commit
- Lint with **clippy** — run `cargo clippy -- -D warnings` before every commit
- **snake_case** functions/variables/modules, **PascalCase** types/traits, **SCREAMING_SNAKE_CASE** constants
@@ -169,8 +170,6 @@ mod tests {
}
```
`Cargo.lock` is **not committed** for libraries — add it to `.gitignore`. Consumers pin their own dependency graph.
---
## 9. Documentation