Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add help text component #373

Open
21 tasks
racheledelman opened this issue Nov 6, 2024 · 1 comment
Open
21 tasks

Add help text component #373

racheledelman opened this issue Nov 6, 2024 · 1 comment
Labels
story User story

Comments

@racheledelman
Copy link
Collaborator

racheledelman commented Nov 6, 2024

Overview

As a form builder, I would like to add hint text, so that I can add extra context to questions.

Context

REFERENCE: This exists in USWDS, but I'm having a hard time finding it specifically described. You can see an example here, the gray text in between the question text and the input:
Image

And here:
Image

Acceptance Criteria

The following questions types should have an optional help text field:

  • short answer
  • radio buttons
  • checkbox*
  • select dropdown
  • paragraph*
  • rich text*
  • I'm unclear on if these question types or another kind of content. If they are question types they should have the help text option.

Question types added in the future should generally have this option as well.

The help text field in the build screen should be a paragraph input, similar to this:
Image

Tasks

Research, design, and engineering work needed to complete the story.

  • [ ]

Definition of done

The "definition of done" ensures our quality standards are met with each bit of user-facing behavior we add. Everything that can be done incrementally should be done incrementally, while the context and details are fresh. If it’s inefficient or “hard” to do so, the team should figure out why and add OPEX/DEVEX backlog items to make it easier and more efficient.

  • Behavior
    • Acceptance criteria met
    • Implementation matches design decisions
  • Documentation
    • ADRs (/documents/adr folder)
    • Relevant README.md(s)
  • Code quality
    • Code refactored for clarity and no design/technical debt
    • Adhere to separation of concerns; code is not tightly coupled, especially to 3rd party dependencies; dependency rule followed
    • Code is reviewed by team member
    • Code quality checks passed
  • Security and privacy
    • Automated security and privacy gates passed
  • Testing tasks completed
    • Automated tests pass
    • Unit test coverage of our code >= 90%
  • Build and deploy
    • Build process updated
    • API(s) are versioned
    • Feature toggles created and/or deleted. Document the feature toggle
    • Source code is merged to the main branch

Decisions

  • Optional: Any decisions we've made while working on this story
@racheledelman racheledelman added the story User story label Nov 6, 2024
@JennyRichards-Flexion
Copy link
Contributor

See #270 as a reference.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
story User story
Projects
None yet
Development

No branches or pull requests

2 participants