Thanks for your interest in contributing!
We welcome pull requests and issue reports. To keep the project healthy and consistent, please follow these guidelines.
- Fork the repository and create your branch from
main. - Make your changes in a feature branch (
feature/my-change). - Ensure your code builds and tests pass locally.
- All changes must come through a pull request into
main. - Direct pushes to
mainare blocked. - At least one approving review is required before merge.
- All CI checks must pass (build, tests, analyzers).
- The project uses .NET analyzers with warnings treated as errors in CI.
- Nullable reference types are enabled.
- Please keep code style consistent with
.editorconfig. - New public APIs should include XML documentation.
- Use clear, descriptive commit messages.
- Signed commits are encouraged but not required.
- Squash or rebase before merging to keep history clean.
- Use Issues to report bugs or request features.
- Please include reproduction steps, expected vs. actual behavior, and environment details where possible.
- Use GitHub Discussions (if enabled) for Q&A, proposals, or general topics.
Participation in this project is governed by our Code of Conduct.
Thank you for contributing to HostBridge!