Contributing to Mir¶
This section provides information for contributors to the Mir project.
Mir is a large C++ project that ships across many platforms and packaging formats, including snaps. The documents in this subsection guide you through the code, help you test changes, and explain how to get your proposals merged.
The Mir development team welcomes new contributors. You do not need to be a compositor developer to make meaningful contributions — improving docs, reporting high-quality issues, and running test plans on real hardware all help ship better releases. If you are looking for a first contribution, check out the good first issues label on GitHub.
In this documentation¶
These pages cover the key aspects of working on Mir
How-to guides - step-by-step guides covering key operations and common tasks
Discussion and clarification of key topics
Technical information - specifications, APIs, architecture
Project and community¶
Mir is a member of the Ubuntu family. It’s an open source project that warmly welcomes community projects, contributions, suggestions, fixes and constructive feedback.
Thinking about using Mir for your next project? Get in touch!
Contributing beyond core development¶
Documentation¶
If you spot unclear wording, outdated examples, or missing guides, see How to contribute documentation to Mir.
Raising issues and requesting features¶
See How to report Mir issues and request features for guidance on writing good bug reports and feature requests, and when to use GitHub issues versus Discourse.
Testing outside day-to-day development¶
You can contribute by validating release candidates and snap environments even if you are not changing Mir source code.