mirror of
https://github.com/spalencsar/bearhub.git
synced 2026-07-07 00:04:15 +02:00
e95a23bc20
- Native runtime under bearhub/ (api, commons, gems, view/util, view/core, view/qt) - bauh/ compatibility re-export shims for legacy imports - Phase D: canonical __version__/__app_name__ in bearhub/__init__.py; pyproject.toml and setup.py point at bearhub package - Native gem loader at bearhub/view/core/gems.py - Namespace compatibility tests (159 tests passing) - Documentation: CHANGELOG [Unreleased], NAMESPACE_MIGRATION, ROADMAP, README, CONTRIBUTING, docs/qt6-migration.md, packaging/aur/README.md
33 lines
1.7 KiB
Markdown
33 lines
1.7 KiB
Markdown
# 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](https://www.python.org/dev/peps/pep-0008/) 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`).
|