Need to update UX checklist
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 818
- Forks
- 249
- Avg merge
- 4d 14h
- Merged PRs (30d)
- 30
Description
As reedline has grown in the number of features it is kind of hard to keep track which and how (existing) features should work for the user, without affecting each other.
Thus, it might make sense to update UX_TESTING.md for stuff that is hard to test automaticallly. Here we can document the most important user-facing behavior for the different subsystems to ensure we don't accidentally break them, when doing major changes.
This would also be a great time to identify potential bugs/friction for the user/behavior that can be easily unit-tested but is currently lacking coverage
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with UX_TESTING.md and review its existing coverage against reedline's user-facing subsystems and features. Document important behaviors that are difficult to test automatically, and identify behaviors that could instead gain unit-test coverage; done means the checklist is updated and the missing-test opportunities are recorded.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation, testing
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100