Skip to content

docs: link CONTRIBUTING.md to PyAutoPrompt as maintainer workflow entrypoint #2

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

Merged
Jammy2211 merged 1 commit into from
Apr 27, 2026
Merged

docs: link CONTRIBUTING.md to PyAutoPrompt as maintainer workflow entrypoint #2

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
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,25 @@ This project uses an AI-first development workflow. Most features, bug fixes, an

3. **Human review** — All AI-generated pull requests are reviewed by maintainers before merging.

## Maintainer Workflow

Maintainer-driven dev work starts as a prompt file in
**[PyAutoPrompt](https://github.com/PyAutoLabs/PyAutoPrompt)** — the public
workflow repo that hosts the PyAuto task registry and the prompt-coupled
Claude Code skills. The pipeline:

1. Write the task as `PyAutoPrompt/<category>/<name>.md` (free-form markdown
describing what to do, with `@RepoName/path/to/file.py` references).
2. `/start_dev <category>/<name>.md` — reads the prompt, audits the code,
drafts the GitHub issue you see in this repo, and files it.
3. `/start_library` or `/start_workspace` — opens a feature worktree under
`~/Code/PyAutoLabs-wt/<task-name>/`.
4. `/ship_library` / `/ship_workspace` — runs tests, opens the PR, and
tracks state in `PyAutoPrompt/active.md`.

External contributors don't need PyAutoPrompt access — open an issue using
the templates in this repo and the same machinery handles it on our end.

## Creating an Issue

When opening an issue, please use the provided issue templates. The **Feature / Task Request** template follows our standard format:
Expand Down
Loading