-
Notifications
You must be signed in to change notification settings - Fork 10
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
USAGOV-2133 readme improvements #2122
Conversation
…gov/usagov-2021 into USAGOV-2133-readme-improvements
…' into USAGOV-2133-readme-improvements
…' into USAGOV-2133-readme-improvements
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for improving this! I made a few suggestions (which probably need some wordsmithing).
Also, since you're going for consistency, GSA has standardized on sentence case for titles. Obviously this matters more for our web sites, but I think it's helpful to carry it through in our internal-focused communications too.
Headings should be in sentence case
Headings Should Not Be in Title Case
This will actually help a bit with consistency, I think, because there are a few very long headings that I see none of us was willing to put in title case
…' into USAGOV-2133-readme-improvements
Jira Task
Updates and Improvements to the README.md file
https://cm-jira.usa.gov/browse/USAGOV-2133
Description
Type of Changes
Testing Instructions
Confirm all links work, instructions are accurate, and language is grammatically and syntactically correct.
Ensure styles are consistent.
Change Requirements
N/A
Validation Steps
N/A
Security Review
N/A
Reviewer Reminders
Post PR Approval Instructions
Follow these steps as soon as you merge the new changes.
Review in Test
and add a comment. State whether the change is already visible on cms-dev.usa.gov and beta-dev.usa.gov, or if the deployment is still in process.