Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (29 loc) · 1.1 KB

CONTRIBUTING.md

File metadata and controls

42 lines (29 loc) · 1.1 KB
Raw

Contributing

Thanks for contributing to code2skill.

Local Setup

python -m pip install --upgrade pip
python -m pip install -e .[dev]

Validation

Run these before opening a pull request:

if (Test-Path dist) { Remove-Item -Recurse -Force dist }
python -m pytest -q
python -m build --sdist --wheel
python -m twine check dist/*

On non-Windows shells, use rm -rf dist before the build.

Repository Areas

  • src/code2skill/: production package code
  • tests/: unit and integration tests
  • docs/: user-facing guides and release notes
  • .github/: workflows and GitHub community-health files

Pull Request Expectations

  • keep changes scoped and reviewable
  • add or update tests for behavior changes
  • update docs when command behavior, API shape, or release process changes
  • for user-facing changes, state the target persona and business scenario being improved
  • update CHANGELOG.md and add docs/releases/vX.Y.Z.md when preparing a release

Release Update Steps

For release preparation, follow the canonical checklist in docs/release.md.