NUKnightLab / NUKnightLab/TimelineJS3
How to handle authoring-time warnings?
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 3.2k
- Forks
- 645
- PR merge metrics
- No merged PRs in 30d
Description
In #221 @hbillings implemented warnings when people accidentally misconfigure the timeline. We discussed how those should surface to people.
In that specific case, I don't believe anyone ever intentionally uses title multiple times, so if the warnings never get seen, it's not a huge deal.
We could consider some option which makes the Timeline treat warnings as fatal and enable that option when people are using our authoring tool. On the other hand, at that point, is it the case that we should just make them errors and push people harder to fix any "issues" earlier instead of having them linger?
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 by reviewing issue #221 and the warning behavior it introduced. The issue does not name a file, test, or entry point, and the desired outcome still needs a decision: warnings surfaced as fatal in the authoring tool, or warnings changed to errors. Done would require an agreed behavior and corresponding implementation and tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- frontend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100