Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (23 loc) · 769 Bytes

CONTRIBUTING.md

File metadata and controls

34 lines (23 loc) · 769 Bytes

Contributing

Thank you for contributing to the DSpace Python client.

Setup

python3 -m venv venv
source venv/bin/activate
pip install --upgrade pip
pip install -e ".[dev]"

Checks

Run these from the project root with the venv activated:

pytest tests/
ruff check dspace_client/ examples/ tests/
mypy dspace_client/

Commit messages

Use clear, imperative subject lines focused on why the change matters (for example: fix: repair adaptive concurrency ramp-up).

Pull requests

  • Keep changes focused; unrelated refactors belong in separate commits.
  • Update CHANGELOG.md under [Unreleased] for user-visible changes.
  • Ensure tests pass before opening a PR.

See also the Contributing section in README.md.