Skip to main content

How to Contribute

We're always looking for people to help make Mylar3 even better, and there are a number of ways to do this:

Bug Reporting / Enchancement Requests​

Bugs (issues) and Enhancements are encouraged to be reported on the Github issue tracker, provided that you:

  • Search existing recent OPEN issues. If an issue is closed, please don't add to it even if you think it's relevant. Though you're welcome to link it in the new issue.
  • Always follow the issue template!
  • Use the CarePackage button on the config page if you need help collecting information.
  • Close your issue when it's solved!

Documentation​

Pull requests to the website repo against the "main" branch are welcome for new articles as well as refinements. You can reach out to the Mylar gang at our discord.

Contributing code (Pull Requests)​

  • Reach out to us on our discord, if you have any questions.

    Pull Requests​

    • Only make pull requests against the nightly branch - never stable!
    • You're probably going to get some comments or questions from us, they will be to ensure consistency and maintainability
    • Each PR should come from its own feature branch not the nightly branch in your fork, with a meaningful name (what is being added/fixed)
    • Make meaningful commits, squash them if necessary.
    • Use Conventional Commits to format your commit messages - applications like commitizen can help you get in that habit.
    • Try to keep it to one feature/bug fix per pull request to keep things clean and easy to understand

Assisting others with Mylar3​

This one is pretty simple - we can't be everywhere to help out everyone with their problems related to Mylar3. We try our best, but we are not going to get them all.

Helping someone, our discord, is our primary aspect of supporting users outside of Github, and any and all help guiding folks to best practices is welcomed!