Thank you for contributing to Mue! However, there are some things you need to take note of before starting your contribution to the Mue project.
By contributing to Mue, you agree that:
- None of the work submitted is plagiarised
- Your contribution will be distributed under the BSD-3-Clause License after it has been merged or implemented otherwise
- Your contribution follows the Code of Conduct
Below are some hints and tips to follow when developing for Mue to reduce the chances of your pull request being closed or having to change many things.
Please don't open issues relating to questions about the project, as it is preferred you contact us via Discord or email instead. When creating an issue, make sure to fill out all the important information and it is much appreciated if you include GIFs/screenshots along with your instructions and possibly even insight of how it would be fixed. Security issues have a specific reporting policy, please see SECURITY.md.
You can request a feature through our feature request template.
We use the Conventional Commits system for our commit names so they are easy to read.
Please keep commit count to a minimum if possible. Do not open an entire pull request just to fix one typo, it is preferred you notify us on Discord or email
instead. See README for an invite.
When coding for Mue projects, keep a few things in mind:
- Dependencies - If there's a lighter alternative, use it. Use as few as possible and keep the bundle sizes small so Mue continues to be fast.
- Code-style - Follow the general codestyle of the repository. Look at .editorconfig and eslint for info.
- Errors - Please fix all errors caused by your changes if possible.
It's preferred that you implement features from our project boards here and here. If you want to add something different, feel free to let us know first on Discord and we can discuss together how it could be implemented along with UI design (we internally use Figma for our design). This is not so important for small features, but for anything major this is crucial to keeping things consistent with the project goals and preventing duplication of work.
- External APIs - This is only applicable to the portions of Mue that the users see: the tab, website, blog and documentation. Please refrain from requesting to such services in order to protect user privacy, and if you must, create a proxy implementation that can be deployed either via Cloudflare Workers or directly in our API.
- Removed Features - Usually, a removed feature will have a reason provided on our project board. Please don't add it back again without consulting us first.
- Pull Requests - Screenshots, especially GIFs are appreciated. We'll try to provide you with some as well when giving feedback.
Feel free to submit any. It would be great if you could include instructions of how the bug was originally triggered, and how you fixed it.
Please don't use Google Translate, and do not open pull requests to any in-development branches as strings may change at any moment without notice.