Improve warning headings and validation status clarity
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 62/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- javascript
Research direction
Start at the GitHub metadata import workflow's validation and review UI, then inspect the existing warning headings, counts, and required-field state. Add or update tests for the initial untouched state and status display; done means labels and counts are unambiguous, import warnings are distinct from validation errors, and untouched required fields are not invalid.
Written by the indexing model from the issue text.
Description
During testing of the GitHub metadata import workflow, the validation/review UI displays warning headings and counts that are difficult to interpret.
Reviewers noted that labels such as "Needs attention," "done well," and "errors" do not clearly communicate what the associated counts represent. There is also some confusion between the warnings generated during metadata import and the warnings/errors displayed during metadata validation.
Additionally, required fields can appear as warnings or errors before the user has interacted with them. Required fields should be clearly indicated, but should not appear invalid simply because they have not yet been filled out or interacted with.
Expected Behavior
- Warning and validation headings should clearly communicate what is being counted.
- Import warnings should be distinguishable from validation errors and fields requiring attention.
- Required fields should be visually marked as required without appearing invalid before user interaction.
- Validation status should be consistent and easy to understand.
Acceptance Criteria
- Clarify the headings and labels used for warnings, errors, and validation status.
- Make the associated counts clearly correspond to the category being displayed.
- Distinguish import warnings from metadata validation errors.
- Prevent untouched required fields from appearing invalid before user interaction.
- Preserve the existing validation logic and behavior.
- Add or update tests covering the initial untouched state and warning/validation status display.
- Dominant language
- JavaScript
- Stars
- 0
- Forks
- 0
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 5
Getting set up
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.
More from Imageomics/OpenCite
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Imageomics/OpenCite#66 ·
Maintainers usually reply within 1 day
-
YAML Field Apostrophe Quotes Parsing IssuePossibly taken @NetZissou claimed this 1 day ago. Openbug
Imageomics/OpenCite#76 · 1 assignee ·
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
Imageomics/OpenCite#73 ·
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 65/100
Imageomics/OpenCite#68 ·
Maintainers usually reply within 1 day
-
Difficulty 3/5 1-2 days Newbie friendliness 68/100
Imageomics/OpenCite#69 ·
Maintainers usually reply within 1 day
All issues in Imageomics/OpenCite
Similar issues
-
[Bug] @deck.gl/arcgis dist import resolves to unpublished @deck.gl/core source path (9.3.11, 9.4.0)Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
stac-utils/stac-fields#42 ·
-
[sec-check] SVG remote-reference gate misses src attributes, link hrefs and bare-string @importOpenagent/security hive/hosted-available-lke648397-260827-5n31 security
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
Maintainers usually reply within 1 day
-
channels:add check:passed
Difficulty 1/5 Under an hour Newbie friendliness 75/100
Maintainers usually reply within 2 days