Skip to content
This repository has been archived by the owner on Feb 22, 2024. It is now read-only.

Latest commit

 

History

History
42 lines (29 loc) · 769 Bytes

CONTRIBUTING.md

File metadata and controls

42 lines (29 loc) · 769 Bytes

Contributing

  1. Fork/clone the repository.

  2. Install dependencies (you'll probably want to create a virtual environment, using your preferred method, first).

    pip install poetry
    poetry install
  3. Install pre-commit hooks

    pre-commit install
  4. After making changes and having written tests, make sure tests pass:

    ward
  5. Commit, push, and make a PR.

Version bumping

cosmospy adheres to semantic versioning via the bump2version utility. Install it with pip:

pip install bump2version

Whenever you need to bump version, in the project root directory do:

bump2version (major | minor | patch)
git push <remote> <branch> --follow-tags
poetry build
poetry publish