getodk / getodk/web-forms

Consider using Git LFS for images of visual tests

Open
#620 0 comments 1 reaction 0 assignees View on GitHub
documentation enhancement
Dominant language
TypeScript
Stars
38
Forks
22
PR merge metrics
No merged PRs in 30d

Description

### Description

To keep the repository size manageable, we can move the e2e visual test images to Git LFS.

Update the Readme to instruct collaborators to install Git LFS after cloning the repository.

---

### Checklist
- **Does it need UI/UX design?**
- [ ] Yes. Describe the UI/UX requirements or attach a Figma link in the "Design" section.
- [x] No
- **Does it need API design?**
- [ ] Yes. Specify the endpoints, methods, or data structures needed.
- [x] No
- **Does it need design around state flow?**
- [ ] Yes. Outline the state flow requirements.
- [x] No
- **Does it need a test plan?**
- [ ] Yes. Add the test plan as a comment in this task or attach the document.
- [x] No

---

### Additional Notes

- It came up from feedback [here](https://github.com/getodk/web-forms/pull/606#discussion_r2709916562)

---

Contributor guide

No contributing guide indexed for this repository

Research direction

Review the feedback in pull request 606 and inspect where the e2e visual test images are stored. Configure those images for Git LFS, update the README with post-clone Git LFS instructions, and verify that the visual tests still find their image files.

Written by the indexing model from the issue text.

Assessment

Tech stack
git
Domain
documentation, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.