How to contribute

Send in bug reports, feature request, comments

• Check if a relevant issue already exists
• If not, please feel encourage to let us know :)

Contribute code

• Fork this project
• Create a topic branch - git checkout -b my_branch
• Push to your branch - git push origin my_branch
• Submit a Pull Request with your branch
• That's it!

Review Code

• If you feel somewhat competent with python but don't want to commit to write code yourself, we could still use a hand having you review our PRs.
• No amount of testing and linting is a substitute for another set of eyes going over our code.
• If you are game, please get in touch and we will either let you know if there is a new PR or you just use githubs watch function.

Translate

[TODO]

Document

• Hamsters documentation is in a rather bad state. We do need technical documentation just as much as user facing help texts.
• If you feel like helping out, but don't want/can't commit too heavily timewise, this would be a great place to start.

User-facing help texts.

• For the time beeing, just use this wiki with to store your contributions. Please make sure to specify where you feel this should be displayed.

Technical documentation

• Currently the backend-code is under heavy refactoring. Although it could generaly greatly profit from doc-strings it most likly would be a waste of anybodys time at this point.
• However, hamster-cli and all frontend related code (hamster-GTK) most certainly could benefit from cleaned up sphinx compatible rst-docstring that may even feature the occasional :param:.
• Don't be disheartened, every docstring helps lets tackle one at a time!