Contributing

Thanks for contributing to Java Inventory.

Development setup

Install the required tools listed in the README, then initialize the project:

python java_inventory.py setup

Install pre-commit for the development hooks:

pip install pre-commit
pre-commit install

Use the CLI directly while developing:

python java_inventory.py --help

Run the linter against your staged changes:

python java_inventory.py lint . --cached

For changes to inventory or coverage behavior, also run the relevant command against the development test project.

For example:

python java_inventory.py test-coverage \
    dev-test/src/main \
    dev-test/src/test

If packaging code changes, verify a local build:

python build.py

Keep changes focused and describe:

Include generated reports or build artifacts only when they are specifically useful for reviewing the change.