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
17 changes: 17 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<!-- Screenshots: `gh pr create --body-file <body> --attach screenshots/before.png --attach screenshots/after.png`
uploads both and rewrites the links below. In the browser, drag each image into its cell instead. -->

<!-- One line: what changed and why. -->

| Before | After |
| --- | --- |
| ![Before](./screenshots/before.png) | ![After](./screenshots/after.png) |

### How it was verified

- **Device:** <!-- simulator name, model and runtime, e.g. stim-tour (iPhone 18 Pro, iOS 27.0) -->
- **Readiness:** <!-- e.g. Stim waited for the app to report ready (3.5s) -->
- **Build:** <!-- build time, and whether it came from Stim's cache -->
- **Logs:** <!-- result of stim logs --errors -->

Built and verified with [Stim](https://github.com/appandflow/stim).
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ dist/
/android
*.log
.DS_Store
/screenshots/
5 changes: 5 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -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`.
1 change: 1 addition & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@AGENTS.md
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/<github-login>.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/<github-login>.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

Expand Down