Add AGENTS.md, CODEOWNERS, and PR template#76
Conversation
Agent-first readiness: - AGENTS.md: documents repo structure, example anatomy, commands, contribution workflow, and CI setup for AI agents and contributors - CODEOWNERS: assigns Web SDK team (nickel) as default reviewers - PR template: standardized checklist for contributions E2E coverage improvements: - Add start:e2e to javascript-vite, typescript-vite, svelte-kit, and vue-composition-api examples so Playwright smoke tests can run against them Refs: #75
|
Nice improvement adding the missing One thing I think is still worth fixing in the same area: A tiny repro of the control flow is: for cmd in false true; do ($cmd); done
echo $?
# 0Would you mind making the runner fail fast with |
| ## Checklist | ||
|
|
||
| - [ ] `npm run format` passes (Biome) | ||
| - [ ] Example has `start` and `start:e2e` scripts in `package.json` |
There was a problem hiding this comment.
I like having a checklist here. I think this specific checkbox will be noisy as written, though: several current examples don’t satisfy start + start:e2e literally.
The four Vite-based examples updated in this PR use dev rather than start, and the .NET examples don’t have a package.json at all. Could we scope this to new Node-based examples, or reword it to match the repo’s actual conventions?
|
|
||
| Every example follows the same pattern: | ||
|
|
||
| - `package.json` with `start` script (dev server on a port) |
There was a problem hiding this comment.
Nice to see an agent guide landing here. One thing I’d tighten up before we rely on it: a few of these repo-wide rules don’t match the current examples yet.
For example, the Vite examples touched in this PR still expose dev + start:e2e, not start, several implementations use NutrientViewer.load() rather than PSPDFKit.load(), and asp-net / blazor don’t have a package.json at all.
Since this file is meant to steer both humans and agents, I think it would be safer to either describe the current state a bit more loosely (for example, “Node-based examples usually have ...”) or bring the repo into line with the guide.
Collect all failing examples and exit non-zero at the end, so a broken example in the middle of the loop can no longer be hidden by later passing examples. Co-authored-by: Miguel Calderón <miguel@nutrient.io>
|
Good catch! Fixed in 71a6675 — the runner now collects all failures and reports them at the end with a non-zero exit, so nothing gets masked. Went with the "collect and report" approach over |
…-api) These examples use pnpm which is not available in CI. Exclude them from e2e tests until pnpm is added to the CI workflow.
…ests These examples fail in CI due to: - svelte-kit, vue-composition-api: require pnpm (not available in CI) - svelte: uses sirv which isn't installed - react: uses react-scripts (CRA) which crashes on Node.js 24 Also removes start:e2e scripts from svelte-kit and vue-composition-api since they can't run in CI anyway.
…trient-web-examples into miguel/agent-first-readiness # Conflicts: # scripts/e2e-tests.sh
What
Adds agent-first infrastructure and improves e2e test reliability.
Agent-first readiness
E2E improvements
start:e2escripts to javascript-vite and typescript-vite (were missing, now testable in CI)e2e-tests.shto continue on failure and report all broken examples at the end, instead of silently masking failuresContext
Part of the agent-first repos initiative discussed in #engineering.
Refs: https://nutrient.atlassian.net/browse/AI-450
Closes https://nutrient.atlassian.net/browse/WEB-4153