Contributing to Mir¶
Mir is a C++ project with Rust components that is developed, tested, and shipped across multiple platforms and packaging formats. This documentation helps contributors understand the codebase, build and validate changes, and participate in the project.
You do not need to be a compositor developer to contribute: documentation improvements, useful issue reports, and testing releases on real hardware all help improve Mir. New contributors can start with the good first issues on GitHub.
In this documentation¶
Get involved and contribute¶
Get involved in Mir to set up a development environment and learn how to contribute.
Develop and maintain Mir¶
Learn about Mir’s architecture, libraries and module structure, and input platform APIs.
Work with graphics support for snaps, debug Mir snaps, update Wayland Explorer, and update symbol maps.
Test, release, and look up development practices¶
Test Mir for a release or validate a graphical snap environment with checkbox-mir.
Read the C++ style guide, continuous integration reference, and DSO versioning guide.
How this documentation is organised¶
The how-to guides cover tasks such as contributing, development, testing, and releasing. Explanations describe the project’s architecture and APIs, while the reference documents development practices and tooling.