Some checks failed
rust-ci / checks (push) Has been cancelled
- Rust workspace: 7 library crates, icenetd CLI, icenet-city (Slint GUI) - Sim: fix false Delivered after a route cut, derive traffic class from payload size, per-link airtime slots (link capacity, queueing) - Docs: single docs/STATUS.md for all figures, remove v0.2/egui leftovers, drop unimplemented seed claims, uncheck store-and-forward - License: LGPL-3.0-or-later (LICENSE, LICENSES/GPL-3.0.txt)
18 lines
1.2 KiB
Markdown
18 lines
1.2 KiB
Markdown
# Contributing conventions
|
||
|
||
- Feature branch: `feat/<short-name>`; fix: `fix/<short-name>`.
|
||
- PR начинается с проблемы и одного конкретного сценария, а не общих обещаний.
|
||
- Прежде чем добавлять crate, проверь зависимость и альтернативу module.
|
||
- Контракты в `docs/architecture/contracts.md`; тесты снаружи `src`.
|
||
- Публичные Rust элементы используют `///` doc comments на **английском**.
|
||
- Область изменения: краткая, отлаживаемая, 250 строк на файл максимум.
|
||
- До реального радио — legal review и тесты аппаратуры.
|
||
|
||
## Suggested PR template
|
||
|
||
- **What / Why:** одна конкретная проблема.
|
||
- **How:** какие crates и интерфейсы изменены.
|
||
- **Tests:** команды и результаты.
|
||
- **Metrics:** новые расходы CPU/RAM/airtime (если затронуты).
|
||
- **Security:** новые доверенные данные/границы.
|
||
- **Alternatives:** почему проще нельзя.
|