Skip to content

docs: tell agents to fill in the PR template #1426

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
inimaz merged 2 commits into from
Sep 23, 2026
+4 −0
Merged

docs: tell agents to fill in the PR template #1426

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1874639
docs: tell agents to fill in the PR template
davidberenstein1957 Sep 23, 2026
140a576
Merge branch 'master' into docs/agent-pr-template
inimaz Sep 23, 2026
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
4 changes: 4 additions & 0 deletions docs/how-to/agent-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,10 @@ The repository includes VS Code launch configurations in `docs/how-to/contributi

The package can work standalone (offline mode) or connect to the API for cloud features and dashboard visualization.

## Opening Pull Requests

Fill in every section of `.github/PULL_REQUEST_TEMPLATE.md` and pass it with `gh pr create --body-file`; a plain `--body` skips the template. Leave the AI Usage Disclosure choice to the human contributor.

## Tips for Effective Development

1. **Start with tests**: Run existing tests first to understand current state
Expand Down
Loading