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

USAGOV-2133 readme improvements #2122

Merged
merged 10 commits into from
Dec 27, 2024
Merged

USAGOV-2133 readme improvements #2122

merged 10 commits into from
Dec 27, 2024

Conversation

whitealbum
Copy link
Contributor

Jira Task

Updates and Improvements to the README.md file

https://cm-jira.usa.gov/browse/USAGOV-2133

Description

Type of Changes

  • New Feature
  • Bugfix
  • Frontend (Twig, Sass, JS)
    • Add screenshot showing what it should look like
  • Drupal Config (requires "drush cim")
  • New Modules (requires rebuild)
  • Documentation
  • Infrastructure
    • CMS
    • WAF
    • WWW
    • Egress
    • Tools
    • Cron
  • Other

Testing Instructions

Confirm all links work, instructions are accurate, and language is grammatically and syntactically correct.
Ensure styles are consistent.

Change Requirements

N/A

  • Requires New Documentation (Link: {})
  • Requires New Config
  • Requires New Content

Validation Steps

N/A

Security Review

N/A

  • Adds/updates software (including a library or Drupal module)
  • Communication with external service
  • Changes permissions or workflow
  • Requires SSPP updates

Reviewer Reminders

  • Reviewed code changes
  • Reviewed functionality
  • Security review complete or not required

Post PR Approval Instructions

Follow these steps as soon as you merge the new changes.

  1. Go to the USAGov Circle CI project.
  2. Find the commit of this pull request.
  3. Build and deploy the changes.
  4. Update the Jira ticket by changing the ticket status to 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.

Copy link
Member

@akf akf 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 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

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@akf akf merged commit 83cc00f into dev Dec 27, 2024
4 of 5 checks passed
@akf akf deleted the USAGOV-2133-readme-improvements branch December 27, 2024 18:35
@akf akf changed the title Usagov 2133 readme improvements USAGOV-2133 readme improvements Dec 27, 2024
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.

2 participants