sjg
eec5aaf811
Keeps README.md, CLAUDE.md, and CONTRIBUTING.md at root as standard project files. Moves AI-generated design/specification documents (AGENTS, AUTH, CONFIGURATION, ENHANCEMENT, MULTI, OVERVIEW, SDR, UI-CAPS) into autogendoc/ to distinguish them from hand-maintained docs. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: Stan Grams <sjg@haxx.space>
2.3 KiB
2.3 KiB
Repository Guidelines
Project Structure & Module Organization
- Workspace root contains
Cargo.toml,README.md, and contributor docs. - Core crates live under
src/:src/trx-core,src/trx-server, andsrc/trx-client. - Server backends are under
src/trx-server/trx-backend(example:trx-backend-ft817). - Client frontends are under
src/trx-client/trx-frontend(HTTP, JSON, rigctl). - Examples live in
examples/and static assets inassets/. - Reference configs are
trx-server.toml.exampleandtrx-client.toml.example.
Build, Test, and Development Commands
cargo build --releasebuilds optimized binaries.cargo testruns the workspace test suite.cargo clippyruns lint checks.- Example server run (release build):
./target/release/trx-server -r ft817 "/dev/ttyUSB0 9600".
Coding Style & Naming Conventions
- Rust standard style: 4-space indentation and rustfmt-compatible formatting.
- Naming:
snake_casefor modules/functions,CamelCasefor types/traits,SCREAMING_SNAKE_CASEfor constants. - Prefer small, crate-focused commits; keep changes localized to the relevant crate.
Testing Guidelines
- Tests are run via
cargo testacross the workspace. - Add tests near the code they cover (module-level unit tests are preferred).
- If you change behavior in a crate, add or update tests in that crate.
Commit & Pull Request Guidelines
- Commit title format:
[<type>](<crate>): <description>(example:[fix](trx-frontend-http): handle disconnect). - Use
(trx-rs)for repo-wide changes that are not specific to any crate. - Allowed types:
feat,fix,docs,style,refactor,test,chore. - Use imperative mood, keep lines under 80 chars, and separate body with a blank line.
- Sign commits with
git commit -sand includeCo-authored-by:for LLM assistance. - Write isolated commits for each crate.
- Pull requests should include a clear summary, test status, and note any config or runtime changes.
Contribution Workflow
- Fork the repository and create a new branch for your changes.
- Follow the project's coding style and conventions.
- Ensure changes are tested and pass existing tests.
Configuration & Plugins
- Configs use TOML. See the example files for required sections and defaults.
- Plugins can be loaded from
./plugins,~/.config/trx-rs/plugins, orTRX_PLUGIN_DIRS.