Skip to content

Latest commit

 

History

History
62 lines (47 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

62 lines (47 loc) · 2.7 KB

Contributing

Thanks for looking. This package is small and additive — please keep it that way.

Getting set up

python -m venv .venv && . .venv/bin/activate
pip install -e ".[test]"
pytest

The rules that matter here

No hard dependency on packvium. dependencies = [] is deliberate: this package must install on its own. packvium is only pulled in through the test extra, to exercise the fallback path.

A missing native wheel must never surface as an unhandled exception from the caller's perspective beyond the one documented RuntimeError. backend() and pack() catch ImportError from the optional packvium-native wheel and fall through to the pure Python package; only if that is also missing does pack() raise, with a message that says what to install.

Determinism. The native and pure-Python paths must agree on every field that packvium documents. A behavioural difference between them is a bug in whichever one is wrong, not a documented quirk.

Pull requests

  • One logical change per pull request.
  • Commit messages in imperative mood, under 72 characters: type(scope): description with feat, fix, refactor, chore, docs or test.
  • Add or update tests. pytest must pass on Python 3.9 through 3.13.
  • Do not bump the version; releases are cut separately.

Reporting a bug

Please include the full request that reproduces it and backend()'s return value at the time. For anything with security implications, follow SECURITY.md rather than opening a public issue.

How your feedback is handled

Every issue and discussion is read by a maintainer. This is what happens next:

  1. New issues are labelled needs-triage. A maintainer answers with one of: a question back to you, a confirmation, or a reason it will not be taken on.
  2. A confirmed bug gets the bug label and is reproduced from your request. A wrong result in one package is checked against the others, because all of them implement the same contract and must agree.
  3. An accepted feature request or idea is added to the project's backlog, and the issue is labelled accepted with a comment saying so. An idea from Discussions is first turned into an issue and linked back to the discussion.
  4. When the change ships, the issue is closed with the release it shipped in. A change to the request or result format can only ship in a release that is allowed to change it, so it may take more than one release.
  5. Declined requests are closed with the reason, so you are never left waiting on a silent issue.

Questions go to Discussions → Q&A; security problems go to Report a vulnerability under the Security tab, never to a public issue.