neon
4.2 KiB
Important
Before writing code or opening a PR, including a draft, discuss your approach in the linked issue and wait for a maintainer to approve it and assign the issue to you. PRs opened without prior approval and assignment will be closed without review. After approval, open a draft PR if the work is not finished.
Closes #
- Maintainer approval: (link to the approval comment)
- Assigned contributor: @
- Type: bug fix | feature | refactor | docs | chore
- UI changed: yes | no
- How I ran this:
pnpm dev| Docker | I did not run it - Evidence captured at commit: (run
git rev-parse --short HEAD)
What changed
Verification
Commands run. Paste the real output tail, including the summary lines. Do not reconstruct or summarize it.
Manual testing. Answer in your own words and be specific. "Tests pass" is not manual testing.
-
First thing you did once it was running, and what you saw:
-
What went wrong or surprised you along the way:
-
What this change is most likely to break, and how you checked that specifically:
Anything you could not test:
Evidence
Upload a recording that proves the changed behavior works in the real client. Show the starting state, the user action, and the final result. If the workflow crosses multiple clients, show the result in each affected client.
Ready-for-review PRs without the required evidence will not be reviewed. Keep the PR in draft until the evidence has been uploaded.
Examples:
- Web: Start from a page load, perform the affected workflow, and show the saved result after refreshing the page.
- KOReader: Perform the affected workflow inside KOReader and show the result there. For sync changes, also show the corresponding result in BookOrbit.
- Kobo: Perform the affected workflow on the device, run the sync, and show the resulting state on the device and in BookOrbit where applicable.
- Scanner, import, or metadata: Add or modify a real book, run the operation through its normal BookOrbit control, and show the resulting book state in the BookOrbit UI.
- Server code used by a client: Trigger the behavior from that client and show the result in the client. Calling the endpoint directly is not end-to-end evidence.
"No UI changes," written testing claims, automated test output, logs, API requests, database queries, and direct service calls are not evidence. They may support the recording but cannot replace it.
Evidence must match the final commit. If the workflow cannot be demonstrated in its real client or device, keep the PR in draft and state what remains untested.
Authorship and review
AI assistance is welcome on this project; unreviewed AI output is not. See the AI usage policy.
- AI tools used:
- Extent (what they wrote, and what you wrote):
- How you verified their output yourself:
- I can explain any line of this diff on request
Contributor checklist
- One focused change, linked above to an issue a maintainer approved
- I discussed my approach and was assigned the issue before writing code or opening this PR
- I read every line of the final diff
pnpm verifypasses against the final diff- Tests added or updated per the testing expectations
- User-facing text uses Vue I18n keys added only to
client/src/locales/en.json; non-English catalogs are unchanged, and accessibility was checked - Documentation updated, where applicable
- No unintended files, secrets, build artifacts, or personal configuration included
- No new dependencies, or the addition was discussed and approved in the linked issue
- I followed the contribution guidelines and commit guidelines