Skip to content

PULL_REQUEST_TEMPLATE.md

Latest commit

 

History

History
141 lines (97 loc) · 3.38 KB

PULL_REQUEST_TEMPLATE.md

File metadata and controls

141 lines (97 loc) · 3.38 KB
Raw

Pull Request Description

Summary

Related Issues

Changes Made

Test Coverage

Coverage Improvements

Before:

  • Coverage: ___%
  • Tests: ___ passing / ___ total

After:

  • Coverage: ___%
  • Tests: ___ passing / ___ total

New Tests Added:

  • Unit tests: ___ tests
  • Integration tests: ___ tests

Test Execution

# Commands used to verify tests
./gradlew test integrationTest
./gradlew jacocoTestReport

Coverage Report Location: build/reports/jacoco/test/html/index.html

CI/CD Status

Build Status

  • ✓ Gradle Build (Java 21) - View Workflow
    • Compilation successful
    • Unit tests passing
    • Integration tests passing
    • Koin DI verification passing
    • JAR artifact created
    • Smoke test passed
  • ✓ SonarQube Analysis - View Workflow
    • Code quality checks passed
    • JaCoCo coverage report generated
    • SonarCloud scan completed (if configured)

How to Verify CI Status

  1. Check Actions Tab: https://github.com/bedaHovorka/interlockSim/actions
  2. View Build Details: Click on the workflow run for this PR
  3. Review Artifacts:
    • JAR: interlockSim-jar-{sha}
    • Test Results: test-results-{sha}
    • Coverage Report: jacoco-coverage-report-{sha}

Coverage Report Validation

Coverage Report URL: Available in GitHub Actions artifacts after CI completes

Key Metrics to Check:

  • Overall instruction coverage ≥ 51% (baseline)
  • No decrease in coverage for modified packages
  • New code has adequate test coverage

Code Quality

Linting and Style

  • Detekt checks passed: ./gradlew detekt
  • Ktlint formatting passed: ./gradlew ktlintCheck
  • EditorConfig rules followed (tabs, max line length 120)

Manual Verification

Tested Scenarios:

Commands Used:

# Example commands for manual testing
./gradlew runSim
./gradlew runEditor
./gradlew runExampleGui

Breaking Changes

  • No breaking changes
  • Breaking changes (describe below):

Documentation

  • README.md updated (if user-facing changes)
  • CLAUDE.md updated (if developer-facing changes)
  • JavaDoc/KDoc comments added/updated
  • Architecture docs updated (if design changes)
  • CHANGELOG.md updated

Checklist

  • All CI checks are passing (see CI/CD Status above)
  • Test coverage maintained or improved
  • JaCoCo report reviewed and validates expected improvements
  • Code follows project style guidelines (tabs, max line 120)
  • No console warnings or errors during build
  • Smoke test passes locally: ./gradlew clean build && java -jar build/libs/interlockSim.jar example shuntingLoop 300
  • Documentation updated as needed
  • Ready for review

Review Notes