Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
74 lines (57 loc) · 2.3 KB

CONTRIBUTING.md

File metadata and controls

74 lines (57 loc) · 2.3 KB
Raw

Contributing to base-cli

Thank you for improving this project.

Please read the Code of Conduct before participating.

Development setup

The basectl shortcuts below are optional. Contributors working outside the Base workspace can run the same checks with the project’s standard Python tooling:

python3 -m pip install -e ".[dev,typer,quality]"
python3 -m pytest
ruff format --check scripts examples
ruff check lib/python/base_cli scripts examples tests
python3 -m mypy --strict examples/typed_consumer.py
python3 scripts/validate_docs.py
python3 -m compileall -q examples
python3 -m build

Use the Python interpreter from your active virtual environment in place of python3 when necessary. The strict mypy command covers the supported typed consumer fixture; the framework-wide typing gate is tracked separately.

Workflow

  1. Create or choose a GitHub issue before starting implementation work.

  2. Use exactly one standard issue category label: bug, enhancement, documentation, ci, or security.

  3. Create an issue-backed branch:

    <category>/<issue>-<YYYYMMDD>-<slug>

    The category prefix must match the issue's single standard category label. This branch shape is tool-independent; feat/, agent/, codex/, and bare issue-number prefixes are invalid.

  4. Use a dedicated Git worktree for each pull request so the main checkout can stay on the default branch:

    git fetch origin
git worktree add -b <branch> ../base-cli-worktrees/<slug> origin/<default-branch>

  5. Keep the pull request scoped to the issue and link it with Fixes #<issue> or Closes #<issue> when merge should close the issue.

  6. Run the project checks before opening or updating a pull request.

  7. Update CHANGELOG.md only for notable user-visible or release-worthy changes.

  8. After merge, sync the default branch, remove the worktree, and delete merged local and remote branches when safe:

    git pull --ff-only origin <default-branch>
git worktree remove ../base-cli-worktrees/<slug>
git branch -d <branch>
git push origin --delete <branch>

Useful commands:

These shortcuts are available to contributors using the Base workspace:

basectl check base-cli
basectl doctor base-cli
basectl test base-cli