Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
83 lines (59 loc) · 2.17 KB

CONTRIBUTING.md

File metadata and controls

83 lines (59 loc) · 2.17 KB
Raw

Contributing to PyJolt

Thank you for your interest in contributing! We welcome bug reports, feature requests, and pull requests.

Development setup

git clone https://github.com/sthitaprajnas/pyjolt.git
cd pyjolt
python -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"

Running tests

# All tests
pytest

# With coverage
pytest --cov=pyjolt --cov-report=term-missing

# Single file
pytest tests/test_shift.py -v

Conformance with reference JOLT

tests/conformance/ runs the reference Java JOLT test fixtures (from bazaarvoice/jolt) against pyjolt, so behaviour stays identical to the Java library and the JOLT demo site.

pytest tests/conformance -q

Cases pyjolt does not pass yet are listed in tests/conformance/known_failures.txt and run as strict xfails:

  • Fixing a known failure: the case starts passing, so the suite fails with XPASS(strict). Delete its line from known_failures.txt.
  • Never add new entries to make a change pass. A case that used to pass and now fails is a regression.
  • Fixing a bug report: add the reporter's spec, input and expected output (from the JOLT demo site) as a regression test.

Code quality

# Lint + auto-fix
ruff check src/pyjolt --fix

# Type check
mypy src/pyjolt

Both must pass with zero errors before a PR is merged.

Submitting a pull request

  1. Fork the repository and create a branch from main.
  2. Add or update tests that cover your change.
  3. Ensure pytest, ruff check, and mypy all pass.
  4. Open a pull request with a clear description and reference any related issues.

Reporting issues

Use GitHub Issues. For security vulnerabilities, see SECURITY.md.

Coding conventions

  • Follow existing code style (enforced by ruff).
  • Full type annotations on all public functions.
  • Docstrings on public classes and methods.
  • No runtime dependencies beyond the Python standard library.

License

By contributing you agree that your contributions will be licensed under the Apache License 2.0.