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

Refine labels and text for Data Files search controls #3394

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from

Conversation

elipe17
Copy link

@elipe17 elipe17 commented Dec 31, 2024

Summary of Changes

How to Test

cd tdrs-frontend && docker-compose up --build
cd tdrs-backend && docker-compose up
  1. Open http://localhost:3000/ and sign in.
  2. Go to the Data Files page
  3. Verify new paragraph text is there
  4. Click the 'Search' button with various selections of the required fields and verify the error messages are correct along with the error count

Deliverables

More details on how deliverables herein are assessed included here.

Deliverable 1: Accepted Features

Checklist of ACs:

  • Add the following paragraph text under the Data Files heading and before the first form input:
  • "Fields marked with an asterisk (*) are required."
  • Add required asterisks to all fields, including the STT field for OFA users, which should already have one.
  • Change the label for the Quarter dropdown to: "Fiscal Quarter*".
  • Ensure that existing form validation rules remain unchanged:
  • Only show relevant fields to each user group.
  • Only count visible errors in the error summary (fields not visible to the user should not be counted as errors).
  • Run the Testing Checklist to confirm all tests pass.
  • Update the README if necessary, to reflect changes to the form or labels.

Deliverable 2: Tested Code

  • Are all areas of code introduced in this PR meaningfully tested?
    • If this PR introduces backend code changes, are they meaningfully tested?
    • If this PR introduces frontend code changes, are they meaningfully tested?
  • Are code coverage minimums met?
    • Frontend coverage: [insert coverage %] (see CodeCov Report comment in PR)
    • Backend coverage: [insert coverage %] (see CodeCov Report comment in PR)

Deliverable 3: Properly Styled Code

  • Are backend code style checks passing on CircleCI?
  • Are frontend code style checks passing on CircleCI?
  • Are code maintainability principles being followed?

Deliverable 4: Accessible

  • Does this PR complete the epic?
  • Are links included to any other gov-approved PRs associated with epic?
  • Does PR include documentation for Raft's a11y review?
  • Did automated and manual testing with iamjolly and ttran-hub using Accessibility Insights reveal any errors introduced in this PR?

Deliverable 5: Deployed

  • Was the code successfully deployed via automated CircleCI process to development on Cloud.gov?

Deliverable 6: Documented

  • Does this PR provide background for why coding decisions were made?
  • If this PR introduces backend code, is that code easy to understand and sufficiently documented, both inline and overall?
  • If this PR introduces frontend code, is that code easy to understand and sufficiently documented, both inline and overall?
  • If this PR introduces dependencies, are their licenses documented?
  • Can reviewer explain and take ownership of these elements presented in this code review?

Deliverable 7: Secure

  • Does the OWASP Scan pass on CircleCI?
  • Do manual code review and manual testing detect any new security issues?
  • If new issues detected, is investigation and/or remediation plan documented?

Deliverable 8: User Research

Research product(s) clearly articulate(s):

  • the purpose of the research
  • methods used to conduct the research
  • who participated in the research
  • what was tested and how
  • impact of research on TDP
  • (if applicable) final design mockups produced for TDP development

- Added paragraph
- updated tests
@elipe17 elipe17 added frontend dev raft review This issue is ready for raft review a11y-review PR is ready for accessibility review labels Dec 31, 2024
@elipe17 elipe17 self-assigned this Dec 31, 2024
Copy link

codecov bot commented Dec 31, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.45%. Comparing base (d516f2d) to head (68504b4).
Report is 12 commits behind head on develop.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #3394   +/-   ##
========================================
  Coverage    91.45%   91.45%           
========================================
  Files          299      299           
  Lines         8605     8605           
  Branches       638      638           
========================================
  Hits          7870     7870           
  Misses         617      617           
  Partials       118      118           
Flag Coverage Δ
dev-backend 91.32% <ø> (ø)
dev-frontend 92.44% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
tdrs-frontend/src/components/Reports/Reports.jsx 87.61% <ø> (ø)
...rontend/src/components/STTComboBox/STTComboBox.jsx 90.90% <100.00%> (ø)

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0323d47...68504b4. Read the comment docs.

Copy link

@raftmsohani raftmsohani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@victoriaatraft victoriaatraft added the Deploy with CircleCI-a11y Deploy to https://tdp-frontend-a11y.app.cloud.gov through CircleCI label Jan 2, 2025
@elipe17 elipe17 added Deploy with CircleCI-a11y Deploy to https://tdp-frontend-a11y.app.cloud.gov through CircleCI and removed Deploy with CircleCI-a11y Deploy to https://tdp-frontend-a11y.app.cloud.gov through CircleCI labels Jan 3, 2025
@victoriaatraft victoriaatraft added Deploy with CircleCI-a11y Deploy to https://tdp-frontend-a11y.app.cloud.gov through CircleCI and removed Deploy with CircleCI-a11y Deploy to https://tdp-frontend-a11y.app.cloud.gov through CircleCI labels Jan 5, 2025
@elipe17 elipe17 added Deploy with CircleCI-a11y Deploy to https://tdp-frontend-a11y.app.cloud.gov through CircleCI and removed Deploy with CircleCI-a11y Deploy to https://tdp-frontend-a11y.app.cloud.gov through CircleCI labels Jan 8, 2025
Copy link

@victoriaatraft victoriaatraft left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshot 2025-01-08 at 9 01 23 AM

@victoriaatraft victoriaatraft removed the Deploy with CircleCI-a11y Deploy to https://tdp-frontend-a11y.app.cloud.gov through CircleCI label Jan 8, 2025
@elipe17 elipe17 assigned ADPennington and unassigned ADPennington Jan 8, 2025
@elipe17 elipe17 requested a review from ADPennington January 8, 2025 17:05
@elipe17 elipe17 removed the request for review from andrew-jameson January 8, 2025 17:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a11y-review PR is ready for accessibility review dev frontend QASP Review raft review This issue is ready for raft review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Refine labels and text for Data Files search controls
5 participants