Skip to content

Latest commit

 

History

History
33 lines (24 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

33 lines (24 loc) · 1.43 KB

Contributing

SidePulse.NET has an initial implementation preview. Discuss significant design changes before expanding the architecture. Keep implemented and verified behavior clearly distinguished from the complete planned product.

Changes and reviews

Use a branch and a pull request against main. Explain the user-visible change, its validation and any hardware limitations. Keep unrelated changes separate. Update wiki sources in docs/wiki in the same pull request as behavior changes. The main repository is the documentation source of truth; direct wiki edits need to be brought back into it before the next automated publication.

Implementation

Use .NET 10 LTS and Spectre.Console for presentation. Keep state reduction, protocol logic and device transports independent of the terminal UI. Keep package versions in Directory.Packages.props and commit updated lock files. Add meaningful unit, transport-contract, hook-failure and hardware smoke tests as those areas arrive.

Rendered, interactive output is for people. Hook and JSON output must have no ANSI sequences, prompts or accidental diagnostic text. Test Windows paths with spaces and Unicode, concurrent sessions and offline phone delivery.

Run the documentation check before submitting:

python scripts/check_docs.py

Retain upstream notices when copying code or assets. The upstream compatibility matrix distinguishes planned, implemented and hardware-verified behavior.