Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

41 lines (29 loc) · 1.13 KB

Contributing to Java Chat

Feedback and contributions are welcome. If you find a bug or want a feature, please open an issue in this repository.

Getting started

  1. Fork the repository
  2. Clone your fork
  3. Create a feature branch
  4. Make your changes
  5. Run checks locally:
make test
make build
make lint
  1. Commit with a descriptive message
  2. Push your branch and open a Pull Request

Guidelines

  • Use the deterministic toolchain: Gradle Wrapper + Gradle Toolchains + Temurin.

  • Local Java is managed by mise/asdf via .tool-versions (see below). The CI uses the same vendor.

  • We pin major Java version in Gradle toolchain and CI; patch is logged in CI and bumped intentionally.

  • Keep PRs focused (one change per PR when possible).

  • Add tests for new behavior.

  • Update docs when you change workflows or endpoints.

  • Don’t commit secrets (use .env, and keep .env.example up to date).

Reporting issues

When reporting an issue, please include:

  • Clear description of the problem
  • Steps to reproduce
  • Expected vs actual behavior
  • OS, Java version, and how you’re running the app (make dev, make run, etc.)