Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
38 lines (22 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

38 lines (22 loc) · 1.38 KB

Contributing to MBCompass

Thank you for your interest in contributing!

We always welcome improvements of all kinds - bug fixes, new features, documentation, translations, and general enhancements.

Reporting bugs and requesting new features

To report bugs or request new features, please use the GitHub issue tracker.

Before you report a bug or request a new feature, check if the bug is already present of if the feature has been requested and potentially was rejected in the past.

Please use the bug and feature templates provided by the GitHub issue tracker.

Code Contribution Guidelines

  • Fork the repository and create a branch (e.g., feature_xyz or improvement_xyz).
  • Make changes and submit a pull request.
  • Describe your changes clearly in the PR.

Translation Contributions

MBCompass supports community-driven translations via Weblate.

If you’d like to help translate the app into your language or improve existing translations, you can do so here:

https://hosted.weblate.org/engage/mbcompass/

No programming experience is required, translations can be done directly in the browser.

Notes

  • For larger changes, please open an Issue in GitHub first to discuss.
  • All derivative work must remain open-source under GPLv3.

Thanks for helping to improve MBCompass!