CONTRIBUTE.md

How to Contribute

1. Review the python library issues for tasks for this implementation.
2. Review the openproficiency model issues for broader tasks.
3. Fork this repository and make your changes.

   ❗️Important: They must be in alignment with the open proficiency model

4. Start the project in a Codespace or local development container.
5. Verify all unit tests pass.
6. Create a pull request.

Run Tests workflow

Before creating a workflow, please run the Unit Tests workflow locally using Act.

act --job verify_unit_tests

act -W .github/workflows/unit-tests.yml --job verify_unit_tests

Publish to PyPI

1. Install tooling (run from the repo root).

   python3 -m pip install --upgrade build twine

2. Clean old artifacts.

   rm -rf dist build *.egg-info

3. Build the package (creates sdist and wheel in dist/).

   python3 -m build

4. Validate metadata (confirm long description renders).

   twine check dist/*

5. Upload to PyPI. Twine will prompt for a password. Use your PyPI API token.

   twine upload dist/*