Skip to content

Navigation Menu

Sign in
Sign up

Contributing

Werkhausen, Malte edited this page Jul 7, 2026 · 1 revision

Contributing

Thanks for helping improve MyShip! 🚒

Branching

The default branch is release/stable. Create a feature branch off it and open a pull request back into it.

Labels

Issues and pull requests use a structured label set:

Area

  • area: server β€” gateway (Node.js, SignalK, MQTT)
  • area: client β€” Angular / Capacitor / Electron app
  • area: docs β€” documentation & design assets
  • area: ci/cd β€” build, Jenkins, tooling & pipelines

Type

  • enhancement, bug, refactor, performance, security, dependencies, documentation

Status (PR workflow)

  • status: wip β€” work in progress, not ready to merge
  • status: needs review β€” awaiting review
  • status: blocked β€” blocked by another issue or dependency
  • status: ready β€” reviewed and ready to merge

New to the project? Look for good first issue.

Pull requests

  1. Branch off release/stable.
  2. Keep changes focused; add/adjust labels (area: + type).
  3. Mark with status: wip while working, status: needs review when ready.
  4. Never commit secrets β€” see Configuration .

License

By contributing you agree your work is licensed under the GNU GPL v3.0.

Clone this wiki locally

AltStyle γ«γ‚ˆγ£γ¦ε€‰ζ›γ•γ‚ŒγŸγƒšγƒΌγ‚Έ (->γ‚ͺγƒͺγ‚ΈγƒŠγƒ«) /