patternfly / patternfly/patternfly-org

Update form guidelines

Open
#3,654 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Content PF5
Dominant language
JavaScript
Stars
74
Forks
147
Avg merge
4d 11h
Merged PRs (30d)
2

Description

Want to update form guideline guidance around required fields and form validation.

Currently, in cases where every field in your form is required, we recommend writing "All fields are required" in grey at the top. Want to update this to be red, and also add guidance that this is optional -- if you think it will easily be missed in your case and having red asterisk in each field wouldn't feel too cluttered, feel free to just add the asterisk.

Also want to remove forced guidance of always disabling submit or next buttons until all fields are filled out correctly.
This is because in some cases, having the ability to press the submit button is the only way to inform users of errors in a form.
Instead, we want to just mention all possibilities for dealing with forms

  • disabling until everything is filled out
  • enabling to allow for error validation on submission
  • field specific form validation

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start from the existing form guidelines and review the sections covering required fields, validation, and submit or next buttons. Update the guidance to cover the red “All fields are required” note as optional, asterisk usage, and all three validation approaches; done means the old mandatory guidance is removed and these options are clearly presented.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.