Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (32 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

45 lines (32 loc) · 1.19 KB

Contributing

Thanks for helping improve ksadk.

Development Setup

git clone https://github.com/kingsoftcloud/ksadk-python.git
cd ksadk-python
uv sync --extra dev

Local Checks

Run focused checks before sending a change:

uv run --extra dev pytest -q
make open-source-audit
make public-docs-audit
uv build
uv run --extra dev python -m twine check dist/*

public-docs-audit builds the curated GitHub Pages candidate from public-docs/. It must not publish .zread/wiki, .zread/site, internal deployment notes, or private generated snapshots.

open-source-audit checks the current public repository candidate for files that should not enter the open-source surface.

Do not push, publish, or create a release before maintainer review.

Pull Requests

  • Keep changes focused.
  • Include tests for behavior changes.
  • Update public docs when user-facing behavior changes.
  • Avoid committing generated caches, local virtual environments, local zread output, internal deployment assets, or private configuration.
  • Mention any release, packaging, or documentation impact in the PR body.

Security

Do not put vulnerability details in a public issue. Follow SECURITY.md.