search

StanfordSpezi / SpeziKt

Kotlin & Android Version of the Stanford Spezi Framework
http://spezi.health/SpeziKt/
MIT License
7 stars 1 forks source link

Bluetooth components unit testing and documentation #11

Closed eldcn closed 1 month ago

eldcn commented 1 month ago

Bluetooth components unit testing and documentation

:recycle: Current situation & Problem

Adds missing documentation (KDocs and module Readme) of bluetooth related components and their corresponding unit tests

:gear: Release Notes

Add a bullet point list summary of the feature and possible migration guides if this is a breaking change so this section can be added to the release notes. Include code snippets that provide examples of the feature implemented or links to the documentation if it appends or changes the public interface.

:books: Documentation

Please ensure that you properly document any additions in conformance to Spezi Documentation Guide. You can use this section to describe your solution, but we encourage contributors to document your reasoning and changes using in-line documentation.

:white_check_mark: Testing

Please ensure that the PR meets the testing requirements set by CodeCov and that new functionality is appropriately tested. This section describes important information about the tests and why some elements might not be testable.

:pencil: Code of Conduct & Contributing Guidelines

By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines:

eldcn commented 1 month ago

@eldcn Amazing job with adding all the tests and documentation in this PR, outstanding work!

One thing that would be great to integrate here to highlight this and track the metric from here on would be to include a codecov upload step as part of the build action. It seems we are almost all the way there anyways: https://about.codecov.io/blog/code-coverage-for-android-development-using-kotlin-jacoco-github-actions-and-codecov/.

I put a codecov token in the GitHub Secrets so adding this to the GitHub Action which we would be able to pass in the codecov GitHub Action like this:

secrets:
  token: ${{ secrets.CODECOV_TOKEN }}

Totally fine if this is done in a separate PR, e.g., as noted in #10

Resolving, and merging this Pull request. @Basler182 already created https://github.com/StanfordSpezi/SpeziKt/issues/10 to address Codecov and I will add it in a separate PR