English
Contributing
Moodiary is an open-source project (AGPL-3.0), and contributions of every kind are welcome.
What you can do
- Report problems: file bugs on GitHub Issues, and include your device model, OS version, app version and the steps to reproduce.
- Suggest features: feature requests go through Issues as well — search first to see whether the discussion already exists.
- Improve the docs: this site lives in the moodiary-docs repository, so you can simply open a Pull Request (every page has an "Edit this page on GitHub" link in the bottom-right corner).
- Translate: the app's copy is managed with slang, and the translation files live in
packages/foundation/moodiary_i18n. - Write code: start by reading Development environment and Coding conventions.
Development workflow at a glance
fork / clone → set up the environment → create a branch → build and test → open a Pull Request- Branch off
develop. - Give your Pull Request a title in Conventional Commits style (for example
feat: support EPUB export). - CI runs analysis, the layer check and the tests; everything has to pass before the branch can be merged.
Pull request checklist
Before you submit, make sure that:
Community
- Official forum: https://answer.moodiary.net
- Telegram: https://t.me/openmoodiary
- QQ group: 760014526
Code of conduct
Please stay kind and respectful. Harassment of any kind will be removed, and repeat offenders will be barred from taking part.