bearhub/CONTRIBUTING.md

How can I contribute?

Well, you can...

• Report bugs
• Add improvements
• Fix bugs
• Add new translations or fix the current ones

Reporting bugs

The best means of reporting bugs is by following these basic guidelines:

• First describe in the title of the issue tracker what's gone wrong.
• In the body, explain a basic synopsis of what exactly happens, explain how you got the bug one step at a time. If you're including script output, make sure you run the script with the verbose flag -v.
• Explain what you had expected to occur, and what really occurred.
• Optionally, if you want, if you're a programmer, you can try to issue a pull request yourself that fixes the issue.

Adding improvements

The way to go here is to ask yourself if the improvement would be useful for more than just a singular person, if it's for a certain use case then sure!

• In any pull request, explain thoroughly what changes you made
• Explain why you think these changes could be useful
• If it fixes a bug, be sure to link to the issue itself.
• Follow the PEP 8 code style to keep the code consistent.

Adding a new translation

• To add a new translation, you will have to create a file in each directory listed below named as the first two letters of the language in the ISO format (e.g: for 'english' would be 'en'):

• bearhub/view/resources/locale
• bearhub/gems/appimage/resources/locale
• bearhub/gems/arch/resources/locale
• bearhub/gems/flatpak/resources/locale
• bearhub/gems/web/resources/locale

New code should use bearhub.* imports. Legacy bauh.* imports still work via compatibility shims (see NAMESPACE_MIGRATION.md).

Run tests before submitting changes:

pip install -r requirements.txt
pip install -e .
python -m unittest discover -s tests -p "test_*.py" -v

CI (.github/workflows/tests.yml) runs the same on push to main (Python 3.11 and 3.12).