Thank you for your interest in contributing to Unitility!
This guide outlines how you can help improve the library — whether by fixing bugs, adding features, improving docs, or proposing new ideas.
- Fork the repository
- Create a branch from
main, e.g.feature/new-quantityorfix/unit-parsing - Make your changes, use story id/number in a commit message id provided,
- Write or update unit tests
- Run the test suite (
mvn clean verify) - Submit a pull request with a clear description of your changes
- Keep changes small and focused
- Use clear, descriptive commit messages
- Follow existing naming conventions and code structure
- All public classes and methods should include Javadoc
- Cover new logic with unit tests
- New physical quantities and their units (at least one for SI/metric and one for an Imperial system),
- Bug fixes (e.g. conversion logic, unit parsing edge cases)
- Integration modules (Quarkus, Spring Boot, Jackson, etc.)
- Additional unit tests for coverage
- Documentation improvements
For a good bug report, include:
- Steps to reproduce
- Expected vs actual behavior
- Sample code (if applicable)
- Unitility version, Java version, OS
Open issues under GitHub Issues
Use GitHub Discussions for:
- General questions
- Feature suggestions
- Design discussions
Thanks again for contributing to Unitility!