Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
66 changes: 66 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
<!--
Thanks for contributing. Keep the PR title in Conventional Commits form,
e.g. `fix(ssh): handle closed tunnel` (types: see commitlint.config.mjs).
Delete any section that does not apply, but do not leave placeholders.
-->

## What and why

<!-- What does this change, and why? Lead with the problem, not the diff. -->

Fixes #
<!-- Use "Fixes #N" to auto-close, or "Refs #N". Write "none" if there is no issue. -->

## Type of change

- [ ] Bug fix
- [ ] New feature
- [ ] Refactor (no behavior change)
- [ ] Docs
- [ ] CI / build / tooling
- [ ] Breaking change (user-visible behavior, CLI flags, config, or provider contract)

## AI assistance

<!-- Using AI to write code is fine. Say how, so reviewers know where to look. -->

- [ ] No AI tools were used
- [ ] AI tools were used (fill in below)

| Field | Answer |
| --- | --- |
| Tool and model | <!-- e.g. Claude Code with claude-sonnet-4, Codex gpt-5, Copilot --> |
| Used for | <!-- e.g. wrote the implementation, wrote tests, refactored, drafted docs, debugging only --> |
| Share of change | <!-- e.g. mostly generated, partly generated, suggestions only --> |

- [ ] I read and understand every line of this change and can explain it in review.
- [ ] I ran the code myself; generated tests were checked to fail without the fix.

## Testing

Behavior changes need integration (e2e) test coverage. Unit tests alone are not enough
for anything that touches the CLI, providers, workspaces, the agent, or the desktop app.

- [ ] CLI / provider / agent change: added or updated Ginkgo integration tests under `e2e/tests/`
- Suite / spec: <!-- e.g. e2e/tests/up, "should reuse an existing container" -->
- Run with: <!-- e.g. mise run cli:test:e2e:focus "reuse an existing container" -->
- [ ] Desktop change: added or updated Playwright e2e tests under `desktop/e2e/`
- Run with: <!-- e.g. mise run desktop:test:e2e -->
- [ ] Added or updated unit tests (`mise run cli:test` / `mise run desktop:test`)
- [ ] No integration test needed, because: <!-- refactor with existing coverage, docs only, CI only. Name the existing spec that covers it. -->

How I verified it manually:

<!-- Commands run and what you observed. Paste output for bug fixes. -->

## Checklist

- [ ] `mise run cli:lint:ci` passes (and `mise run desktop:check` for desktop changes)
- [ ] `mise run cli:test` passes
- [ ] Docs under `sites/` updated for user-visible changes
- [ ] No secrets, tokens, or personal paths in code, logs, or screenshots
- [ ] I have signed the [CLA](https://github.com/devsy-org/devsy/blob/main/.github/CLA.md) (the bot will comment if not)

## Notes for reviewers

<!-- Optional: risky areas, design tradeoffs, follow-ups, screenshots for UI changes. -->
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,14 @@ devsy://import?workspace_id=<id>&workspace_uid=<uid>&devsy_pro_host=<host>&optio
- `/sites` - Documentation and download websites
- `/hack` - Build and development scripts

## Pull Requests

The pull request template asks for three things reviewers rely on:

- **AI disclosure.** AI-assisted code is welcome. State the tool, model, and what it was used for, and make sure you understand every line you submit.
- **Integration tests.** CLI behavior changes need Ginkgo e2e coverage under `e2e/tests/`. Desktop behavior changes need Playwright e2e coverage under `desktop/e2e/`. Unit tests alone are not enough. If you believe no integration test is needed, say why in the PR.
- **Conventional Commit title.** The title becomes the squash commit subject.

## Getting Help

- [Documentation](https://devsy.sh/docs)
Expand Down
Loading