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

Update README.md #476

Closed
wants to merge 3 commits into from
Closed

Update README.md #476

wants to merge 3 commits into from

Conversation

kiranrokkam09
Copy link

Updated the outdated readme file. Just leaving one portion "Update information about unit testing".

Fixes: #455

Additions

  • added a link to where this app lives on consumerfinance.gov
  • Updated the screenshot.
  • Updated Dependencies section to Design System.
  • changed react-typeahead to React bootstrap typeahead

Removals

Changes

Testing

Screenshots

Notes

Todos

Checklist

  • Changes are limited to a single goal (no scope creep)
  • Code can be automatically merged (no conflicts)
  • Code follows the standards laid out in the front end playbook
  • Passes all existing automated tests
  • New functions include new tests
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged
  • Visually tested in supported browsers and devices
  • Project documentation has been updated (including the "Unreleased" section of the CHANGELOG)

Copy link
Member

@higs4281 higs4281 left a comment

Choose a reason for hiding this comment

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

Thanks for the work on the README.

I've suggested a couple changes.

This is not an urgent issue, and since @flacoman91 did the bulk of recent work on ccdb5-ui, I'd like to give him a chance to review. That could take a while, as he's on an extended leave.

README.md Outdated
1. [Capital Framework](https://cfpb.github.io/capital-framework/) - CFPB standard styling and controls
1. [History](https://github.com/reacttraining/history) - Integrating the address bar with the application
1. [dayjs](https://day.js.org/) - Better date handling than native JavaScript
For detailed information about the design system and its underlying components, please refer to the official [Design System Documentation](https://thedesignsystem.guide/documentation). The design system provides standardized styling, controls, and guidelines, ensuring a unified user experience throughout the application.
Copy link
Member

Choose a reason for hiding this comment

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

This is not the design system we use. The CFPB has its own design system:
https://cfpb.github.io/design-system/

Copy link
Member

Choose a reason for hiding this comment

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

Also, I think I'd dial back the verbiage on the design system. We don't need to sell it.

Copy link
Author

Choose a reason for hiding this comment

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

ok then i will make the suggested changes.

README.md Outdated Show resolved Hide resolved
Co-authored-by: william higgins <higs4281@users.noreply.github.com>
@kiranrokkam09
Copy link
Author

hey @higs4281 can you merge it by the month end as I am participating in hacktoberfest.

@flacoman91
Copy link
Contributor

flacoman91 commented Oct 26, 2023 via email

@kiranrokkam09
Copy link
Author

@contolini @anselmbradford can you look into my pr and merge it by the month end as I am participating in hacktoberfest.

README.md Show resolved Hide resolved
@billhimmelsbach
Copy link

Hi @kiranrokkam09! 👋

@contolini mentioned to me that you were looking to make contributions for Hacktoberfest, which is awesome! If you're interested in a small React issue, I made a testing issue for you in our repo dedicated to implementing the CFPB design in React. It's a request for a few tests to check if styles are being rendered properly for one of our new components. No pressure, but I wanted you to have every opportunity to contribute to the CFPB this month.

Thanks!

@contolini
Copy link
Member

Thanks for this PR @kiranrokkam09. It has a handful of problems so I'm going to close it. If you'd like to help out with our design system, check out the issue @billhimmelsbach linked to above. 🎃

@contolini contolini closed this Oct 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update readme
6 participants