Contributing
OpenVitals is early and practical feedback is valuable.
Useful Bug Reports
Include:
- Device model.
- Android version.
- Health Connect provider and version if known.
- OpenVitals version.
- Which permissions were granted.
- Which screen or workflow failed.
- Whether the data exists in Health Connect.
- Screenshots or logs when they help explain the issue.
Where To Report Issues
Use the Android app repository for app bugs:
codeberg.org/OpenVitals/android-app/issues
Use the website repository for documentation or website issues:
codeberg.org/OpenVitals/docs/issues
Development Workflow
- Clone the Android app repository.
- Build or run
./gradlew verifyLocalApp. - Keep the local app internet-free.
- Keep Health Connect writes inside explicit Add entry or edit-entry workflows.
- Add tests when changing shared behavior, permissions, period selection, formatting, or Health Connect query logic.
Documentation Workflow
- Clone the website repository.
- Install MkDocs dependencies.
- Run
mkdocs servefor local preview. - Run
mkdocs build --strictbefore opening a pull request.
python -m pip install -r requirements.txt
mkdocs build --strictTranslation Notes
The Android app currently supports English, Spanish, German, and Italian language preferences.
When changing user-facing app copy, keep translations in sync or call out the missing translation work clearly in the issue or pull request.