Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (33 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

46 lines (33 loc) · 2.03 KB

Contributing to PortPane

You do not need to be a programmer to contribute. Some of the most valuable contributions are device database entries (just a VID and PID from Device Manager) and translations (no coding experience required — just copy a file and translate the text between tags). If you know a radio interface or USB adapter that PortPane should recognize, or if you speak another language, your help is welcome.

Thank you for your interest in contributing to PortPane by ShackDesk.

Ways to Contribute

Type How
Bug report Open a Bug Report issue
Feature request Open a Feature Request issue
USB device addition Open a USB Device issue or submit a PR editing data/usb_devices.json
Translation See TRANSLATING.md and open a Translation issue
Code Fork, branch, and submit a pull request (see below)

CLA

All contributors must agree to the Contributor License Agreement before a pull request can be merged. By submitting a PR, you agree to its terms.

Code Standards

  • MVVM strictly enforced. No business logic in code-behind files (.xaml.cs). All logic lives in ViewModels and Services.
  • No hardcoded strings. All branding values reference BrandingInfo constants.
  • No admin rights. The app must run as standard user (asInvoker).
  • Logging via Serilog only. No Console.WriteLine, Debug.WriteLine, or Trace.
  • C# 12 / .NET 8 target only. No .NET Framework or .NET Standard targets.

Pull Request Process

  1. Fork the repository
  2. Create a branch: feature/my-feature or fix/my-bug
  3. Make your changes
  4. Run tests: dotnet test
  5. Submit a pull request — fill out the PR template fully
  6. A maintainer will review within 7 days

Questions?

Post in GitHub Discussions.