From a26cc1972e18579f3fbf5cf8e80d658d64748486 Mon Sep 17 00:00:00 2001 From: Samuel K Date: Sun, 18 Oct 2026 11:55:30 -0600 Subject: [PATCH 1/2] docs: add pull request template with AI disclosure and e2e requirement --- .github/pull_request_template.md | 65 ++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 8 ++++ 2 files changed, 73 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000000..240d287506 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,65 @@ + + +## What and why + + + +Fixes # + + +## 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 + + + +- [ ] No AI tools were used +- [ ] AI tools were used (fill in below) + +| Field | Answer | +| --- | --- | +| Tool and model | | +| Used for | | +| Share of change | | + +- [ ] 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. + +- [ ] Added or updated integration tests under `e2e/tests/` (Ginkgo) + - Suite / spec: + - Run with: +- [ ] Added or updated unit tests +- [ ] Added or updated desktop tests (`mise run desktop:test` / `desktop:test:e2e`) +- [ ] No integration test needed, because: + +How I verified it manually: + + + +## 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 + + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 38bd0ebd47..345637d953 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -274,6 +274,14 @@ devsy://import?workspace_id=&workspace_uid=&devsy_pro_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.** Behavior changes need Ginkgo e2e coverage under `e2e/tests/`. 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) From 90e4e982a314e90f5aef0ce882e9f5cc8b334966 Mon Sep 17 00:00:00 2001 From: Samuel K Date: Sun, 18 Oct 2026 12:07:19 -0600 Subject: [PATCH 2/2] docs: split CLI and desktop e2e requirements in PR template --- .github/pull_request_template.md | 7 ++++--- CONTRIBUTING.md | 2 +- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 240d287506..5f49e31322 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -41,11 +41,12 @@ Fixes # 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. -- [ ] Added or updated integration tests under `e2e/tests/` (Ginkgo) +- [ ] CLI / provider / agent change: added or updated Ginkgo integration tests under `e2e/tests/` - Suite / spec: - Run with: -- [ ] Added or updated unit tests -- [ ] Added or updated desktop tests (`mise run desktop:test` / `desktop:test:e2e`) +- [ ] Desktop change: added or updated Playwright e2e tests under `desktop/e2e/` + - Run with: +- [ ] Added or updated unit tests (`mise run cli:test` / `mise run desktop:test`) - [ ] No integration test needed, because: How I verified it manually: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 345637d953..7b4b1cf055 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -279,7 +279,7 @@ devsy://import?workspace_id=&workspace_uid=&devsy_pro_host=&optio 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.** Behavior changes need Ginkgo e2e coverage under `e2e/tests/`. Unit tests alone are not enough. If you believe no integration test is needed, say why in the PR. +- **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