Skip to content

Latest commit

 

History

History
45 lines (25 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

45 lines (25 loc) · 1.87 KB

Contributing to Tauon Music Box

Wanna contribute? Theres a few ways you can:

Questions

You feel free to ask questions as a new Github issue. Please do not comment in an existing or old issue unless you're the author or you're sure its directly releated.

You can also use the github discussions feature.

If you use Discord it may be faster to ask on the official server.

If your question is implicitly a bug/feature request then please create an issue with your question.

Issues

If you encounter an issue, feel free to create new issues on github.

Possibly helpful information to include:

  • What method did you use to install Tauon?
    • Flatpak? Snap? AUR? Other/Manual?
  • What version number is shown under MENU > Settings... > About
  • For audio/transition related issues, what backend do you have selected under MENU > Settings... > Audio. Does the issue happen on both backends? Are you playing local files, or files from a particuar network server?
  • For crashes, it would be most helpful if you could replicate the crash and capture the error from terminal output.
    • To run manually for AUR install: tauon. For Flatpak: flatpak run com.github.taiko2k.tauonmb

For suggestions, I may or may not choose to implement certain things. Explaining how a feature would be integrated would be more helpful than vague ideas. Design concepts would be interesting to see, but you should check with me before investing too much time into it.

Translations

See here

Code Contributions

The code base for core and UI related elements is very (very) messy, and there are strict design requiements, as such I don't expect code contributions for these things.

Tauon's submodules are more manageable to work on.

Other

Other areas for contribution could include website design, promotion and documentation.