We appreciate your interest in contributing to Mergin Maps! Community involvement is essential for the health and longevity of this project. Below outlines the different ways you can contribute and the process for submitting code changes.
There are several ways you can help improve Mergin Maps:
- 💻 Code contributions: Writing or fixing code.
- 🌏 Translations: Helping us translate the mobile app.
- 📣 Spreading the Word: Sharing your experience by giving talks or using social media.
- 🤯 Reporting Problems: Submitting bug reports or issues to our support.
- 💡 Suggesting Changes: Proposing new features or improvements on our Wishlist.
- 💸 Financial Support: Donate or subscribe to the Mergin Maps Cloud service to help us maintain the project.
If you need help or guidance with any of these contribution types, please reach out in our community chat.
To maintain stability and quality, we use a standard process for accepting code contributions:
If you have a solution for an existing bug, the process is straightforward:
- Fork the repository.
- Create a branch for your fix.
- Implement and test the bug fix.
- Submit a Pull Request (PR) against the project's default branch.
Bug fixes will be reviewed and merged once approved.
All new features or substantial changes must be discussed and approved by a core contributor before coding begins.
- Open an Issue outlining the feature or major change you intend to implement.
- Wait for approval on the Issue from a project contributor.
- Once approval is granted, proceed with the implementation (Fork → Branch → PR).
If you have questions about implementation details, testing, or need general assistance, we encourage discussion:
- Technical Discussions: For details on specific code changes, please use the comments on the relevant Issue.
- Community Chat: For real-time help, general questions, or to connect with other contributors, please join our community chat: https://merginmaps.com/community/join.
Thank you for contributing 💙 — we appreciate your time and expertise!