CONTRIBUTING.md

Contributing to LabWired Core

First off, thank you for considering contributing to LabWired! It's people like you that make LabWired such a great tool.

How Can I Contribute?

Reporting Bugs

• Use the Bug Report template.
• Describe the exact steps to reproduce the issue.
• Include your system.yaml and the firmware version if applicable.

Suggesting Enhancements

• Use the Feature Request template.
• Explain why this enhancement would be useful to most LabWired users.

Adding New Architectures or Peripherals

• We love new hardware support!
• Check out our Peripheral Modeling Guide.
• Ensure you include unit tests for new peripherals.
• Use the New Peripheral PR template.

Style Guide

• Run cargo fmt before committing.
• Ensure cargo clippy passes without warnings.
• Write clear, concise commit messages.

Local Pre-Hooks (Required)

Install local hooks so CI failures (format/lint/test) are caught before push:

cd core
./scripts/install-hooks.sh

Installed hooks:

• pre-commit: cargo fmt --check, cargo clippy --all-targets -D warnings, cargo check (host workspace)
• pre-push: cargo fmt --check, cargo clippy --all-targets -D warnings, cargo test (host workspace)

Pull Request Process

1. Create a branch from main.
2. Ensure the core-integrity status check passes (formatting, linting, workspace tests).
3. If you touch board models, configs, or examples, the relevant Smoke Tests and Coverage Matrix checks will trigger automatically. Ensure they pass if triggered.
4. Update relevant documentation.
5. Your PR will be reviewed by the maintainers.

License

By contributing, you agree that your contributions will be licensed under the MIT License.