Skip to content

docs: align contributor setup with current Python, branch and CLI - #104

Open
sang-d wants to merge 1 commit into
GenAI-Security-Project:mainfrom
sang-d:docs/contributor-setup-20260922
Open

sang-d wants to merge 1 commit into
GenAI-Security-Project:mainfrom
sang-d:docs/contributor-setup-20260922

Conversation

@sang-d

@sang-d sang-d commented Sep 22, 2026

Copy link
Copy Markdown

The contributor guide currently recommends Python 3.8+, a v0.2 base branch, and a --model_id CLI option. The current package requires Python 3.11+, the repository's default branch is main (v0.2 is absent), and the CLI accepts model_id as a positional argument. These instructions can prevent a new contributor from installing the package or running the documented example.

Update those three instructions and link the Python requirement to pyproject.toml. This changes only CONTRIBUTING.md.

Validation: compare the Python requirement with package metadata and CI, check the live branch list, and parse the documented CLI command using the argument declarations in src/cli.py. The original instructions fail the consistency checks and the patch passes. Product tests and live Hugging Face generation are not needed for this documentation-only change and were not run.

Prepared with AI assistance. Maintainer review is requested; no affiliation or endorsement is implied.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant