Intelligent-Instruments-Lab / Intelligent-Instruments-Lab/iil.is
better errors for usability
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 4
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
The user experience of editing files on github and refreshing the site is pretty sharp-edged, especially for non-programmers. But Even running the site locally and knowing javascript, I often don't get a descriptive error in the terminal or browser console.
Examples:
- syntax errors in markdown and json files often cause silent failures -- would be good if the offending file could always print to browser console, better yet if the syntax error could be printed
- when adding new people to the "People" page, it is necessary to edit
order.json. if there are people withmdfiles but no entries inorder.json, they don't appear on the page. If there are entries inorder.jsonwithoutmdfiles, the page breaks with an inscrutable error. Ideally, the page would be robust to a mismatch or at least identifyorder.jsonas the source of the problem.
Contributor guide
No contributing guide indexed for this repository
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 by reproducing the silent markdown/JSON failures locally and inspect the People page handling of order.json. Trace how files are loaded and how mismatches between people markdown files and order.json are reported in the terminal or browser console. Done means failures identify the offending file or order.json and provide a descriptive error instead of failing silently or inscrutably.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, json, markdown
- Domain
- frontend
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100