StanfordSpezi / SpeziKt

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

Introduce Detekt #6

Closed eldcn closed 1 month ago

eldcn commented 2 months ago

Problem

Ensuring consistency in coding style can easily become challenging. Without a standardized approach, the codebase may accumulate technical debt, leading to reduced maintainability.

Solution

Introducing detekt. Detekt is a static code analysis tool specifically designed for Kotlin, which is able to detect code smells, and enforces coding style conventions. It can be setup locally and integrated into CI/CD pipelines. We can therefore automate code quality checks and enforce best practices consistently across the codebase

Additional context

No response

Code of Conduct

PSchmiedmayer commented 2 months ago

In addition, it might make sense to add a CodeQL setup to this repo?

We have started to use it for some of our other packages and it seems to be a well maintained additional layer of detecting possible security issues and common mistakes right in PRs.