diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..d20fba0 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,17 @@ + + + + +| Before | After | +| --- | --- | +| ![Before](./screenshots/before.png) | ![After](./screenshots/after.png) | + +### How it was verified + +- **Device:** +- **Readiness:** +- **Build:** +- **Logs:** + +Built and verified with [Stim](https://github.com/appandflow/stim). diff --git a/.gitignore b/.gitignore index 508d707..902b038 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,4 @@ dist/ /android *.log .DS_Store +/screenshots/ diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..b2e1371 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,5 @@ +# Agent instructions + +This is the Stim tutorial app. Follow `stim guide tutorial run` (or `npx stim guide tutorial run` when `stim` is not installed). + +Before you open a pull request, follow `stim guide tutorial share`. diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..43c994c --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1 @@ +@AGENTS.md diff --git a/README.md b/README.md index 4e35319..6e7ddbd 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ If `stim` is installed globally, drop `npx`. The Android version is `stim androi ## Tutorial pull requests -The last tutorial step can open a pull request to this repo with a screenshot at `finish/.png`. A workflow (`.github/workflows/tutorial-finish.yml`) comments, adds the `tutorial-finish` label and closes the PR without merging. It uses `pull_request_target` and only calls the GitHub API; it never checks out or runs the PR's code. +The optional share step can open a pull request to this repo with before and after screenshots of your change, following `.github/pull_request_template.md` (older Stim versions commit one screenshot at `finish/.png`). A workflow (`.github/workflows/tutorial-finish.yml`) comments, adds the `tutorial-finish` label and closes the PR without merging. It uses `pull_request_target` and only calls the GitHub API; it never checks out or runs the PR's code. ## License