docs: Create community standards files#37
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces comprehensive project documentation and contribution guidelines, including a new pull request template, a detailed contributing guide, and a security policy. It also refines existing documentation in AGENTS.md and README.md to improve clarity and accessibility. Feedback suggests correcting the specific code coverage percentages in the contributing guide to match the build configuration, ensuring consistent use of bash syntax highlighting, and including static analysis commands in the agent instructions for better local verification.
| - **Build tool**: [Gradle](https://gradle.org/) with Kotlin DSL | ||
| - **Testing**: [JUnit 5](https://junit.org/junit5/) through [kotlin-test](https://kotlinlang.org/api/latest/kotlin.test/) | ||
| - **Static analysis**: [Detekt](https://detekt.dev/) with auto-correction | ||
| - **Code coverage**: [Kover](https://github.com/Kotlin/kotlinx-kover), with minimum coverage requirements of 90% coverage |
There was a problem hiding this comment.
The documentation mentions a 90% coverage requirement, but the build.gradle.kts file specifies 90% for instructions and lines, and 67% for branches. Additionally, the word 'coverage' is repeated at the end of the sentence. Updating this line will improve accuracy and clarity for contributors.
| - **Code coverage**: [Kover](https://github.com/Kotlin/kotlinx-kover), with minimum coverage requirements of 90% coverage | |
| - **Code coverage**: [Kover](https://github.com/Kotlin/kotlinx-kover), with minimum coverage requirements of 90% for instructions and lines, and 67% for branches |
| ## Automations | ||
|
|
||
| The project runs [Detekt](https://detekt.dev/) before every push through a pre-push Git hook. This helps catch common quality and style issues before code is pushed. In normal situations, Git hooks are installed automatically, so you should not need to configure them manually. If, for some reason, the Git hooks are not installed automatically, you can install them by running: | ||
| ```sh |
There was a problem hiding this comment.
For consistency with the other code blocks in this file (e.g., line 37), it is recommended to use bash as the language identifier for the code block instead of sh.
| ```sh | |
| ```bash |
| @@ -34,12 +31,6 @@ where each TypeResolver handles specific types. | |||
|
|
|||
| # Run tests with fresh execution (ignore cache) | |||
| ./gradlew test --rerun-tasks | |||
There was a problem hiding this comment.
Since the project enforces static analysis via Detekt in a pre-push hook, it is highly recommended to include the detekt command in the instructions for coding agents. This ensures that agents can verify their changes against the project's style and quality standards locally.
| ./gradlew test --rerun-tasks | |
| ./gradlew test --rerun-tasks | |
| # Run static analysis | |
| ./gradlew detekt |
1 participant
No description provided.