Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sang-d wants to merge 1 commit into
base: main
Choose a base branch
from
Open

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ Thank you for your interest in contributing to the OWASP AIBOM Generator! This p
git clone https://github.com/YOUR_USERNAME/aibom-generator.git
cd aibom-generator
```
3. **Set up your environment**:
3. **Set up your environment** with Python 3.11 or newer, as required by
[`pyproject.toml`](pyproject.toml):

```bash
# Local Python setup
Expand Down Expand Up @@ -43,7 +44,7 @@ type/issue-number-description

### Pull Request Process

1. Create a branch from `v0.2` (or `main` for documentation)
1. Create a branch from `main`
2. Make your changes with clear, focused commits
3. Push to your fork and open a PR
4. Link your PR to any related issues
Expand All @@ -68,7 +69,7 @@ type(scope): description

### Python Style

- **Python 3.8+** compatibility required
- **Python 3.11+** compatibility required (see `requires-python` in `pyproject.toml`)
- Follow existing patterns in the codebase
- Use type hints for function signatures

Expand Down Expand Up @@ -165,7 +166,7 @@ pip install -e '.[dev]'
python -m uvicorn src.main:app --reload --port 7860

# Or use CLI
python -m src.cli --model_id "microsoft/DialoGPT-medium"
python -m src.cli "microsoft/DialoGPT-medium"
```

## Updating Dependencies
Expand Down