Contributing Guidelines

Contributions of all kinds are welcome, not only in the form of code but also with regards bug reports and documentation.

Please keep the following in mind:

  • Bug Reports: Make sure you're running the latest version. If the issue(s) still persist: please open a clearly documented issue with a clear title.
  • Minor Bug Fixes: Please send a pull request with a clear explanation of the issue or a link to the issue it solves.
  • Major Bug Fixes: please discuss your approach in an GitHub issue before you start to alter a big part of the code.
  • New Features: please please discuss in a GitHub issue before you start to alter a big part of the code. Without discussion upfront, the pull request will not be accepted / merged.

Thanks for your help in making MagicMirror² better!

Working Language

To ensure inclusivity, collaboration, and accessibility for contributors from all around the world, we have chosen English as the working language for this project. Here are the key reasons behind this decision:

  1. Global Accessibility: English is widely recognized and understood, enabling a diverse group of contributors to participate, share ideas, and collaborate effectively without language barriers.
  2. Uniform Documentation: Using English for documentation ensures that all project materials are consistent and comprehensible to the majority of developers, regardless of their native language.
  3. Broader Community Engagement: By using a common language, we can engage with a broader community, attracting talent and contributions from various regions and backgrounds.
  4. Resource Availability: Most technical resources, tutorials, and libraries are available in English, providing contributors with a wealth of information and tools to support their work.

We understand that choosing English as the working language is not the perfect solution for everyone, as it may present challenges for non-English speakers. However, it is the best compromise to ensure effective communication and collaboration across our diverse and global community.

If you are not comfortable with English and cannot use translation tools, please feel free to use your native language in the forum. However, please keep in mind that asking questions in English is more likely to get you help quickly.

We appreciate your understanding and cooperation in using English as the working language. Together, let's build something amazing!