Skip to content

Latest commit

 

History

History
42 lines (23 loc) · 2.98 KB

CONTRIBUTING.md

File metadata and controls

42 lines (23 loc) · 2.98 KB
Raw

Contributing to Mudita Center

Mudita Center is an Open Source project and we're more than happy to receive contributions from our community. There are many ways in which you can contribute to the project from reporting bugs, suggesting features to writing code and documentation.

Before contributing please read and accept our Code of Conduct.

Note: Before writing a new piece of code please make sure that the thing you want to fix/add can't be simulated using the built-in Developer mode or isn't explained in Mudita Center Wiki.

Reporting bugs

If you think you found a bug or a security issue in Mudita Center, we'd love to hear from you. Before you create a relevant GitHub issue please:

  • make sure you're using the latest Mudita Center release when spotting the bug by heading to the Mudita Center -> About Mudita Center menu inside Mudita Center. Here you can see the all the details about the version of Mudita Center you're currently using. Please compare it with the latest stable release of Mudita Center which is always available at the top of our changelog.

  • make sure that the issue hasn't been already reported on GitHub issues (if it has, please add a 👍 reaction to it).

Reporting a bug - template

Please make sure that your bug report includes the following data:

  • General description (what happened)
  • Expected behavior (what you think should happen)
  • Current behavior (current 'buggy' behavior)
  • Steps to reproduce the bug

Feel free to add any screenshots or gifs/screencasts to illustrate the issue.

Feature requests

If you have an idea for a feature that could possibly land in Mudita Center please let us know by simply creating an issue on GitHub in which you describe the feature, why it would be useful and how it should work. Before you create a Feature request on GitHub please:

  • make sure that the feature request hasn't been already reported on GitHub issues (if it has, please add a 👍 reaction to it).

Contributing code and documentation changes

If you would like to contribute a new feature or a bug fix to Mudita Center, please discuss your idea first in Github issues. If there is no GitHub issue for your idea, please open one. It may be that somebody from Mudita core team is already working on it, or that there are particular complexities that you should know about before starting the implementation.

Please refer to the Development workflow article to learn how to submit code and documentation changes to the Mudita Center repository.

If you want to start localizing Mudita Center interface please start from the "Internationalization" article.

Note: Mudita Center comes with both lint-staged and Prettier setup to ensure a consistent code style.