Skip to content

feat: introduce a style guide #2996

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

feat: introduce a style guide #2996

wants to merge 2 commits into from

Conversation

steveoh
Copy link
Member

@steveoh steveoh commented Apr 22, 2025

here we go!

@steveoh steveoh requested review from miriamseely and leault April 22, 2025 00:05
Copy link

netlify bot commented Apr 22, 2025

Deploy Preview for gis-utah-gov ready!

Name Link
🔨 Latest commit 73d8eac
🔍 Latest deploy log https://app.netlify.com/sites/gis-utah-gov/deploys/6806dd424b43f20007f4c329
😎 Deploy Preview https://deploy-preview-2996--gis-utah-gov.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 96 (no change from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 100 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

<h3>Capitalization</h3>
<p>The following terms are always capitalized:</p>
<BulletedList>
<li>State (when referring to the political entity)</li>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Stephanie pointed out that this bit about capitalizing state conflicts with DGO's style guide. Apparently they like 'state of Utah' better than State of Utah, so we can remove this bit about capitalizing state.

</BulletedList>
<h3>Numbers and units</h3>
<BulletedList>
<li>Spell out numbers one through ten. For larger numbers, use numerals.</li>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
<li>Spell out numbers one through ten. For larger numbers, use numerals.</li>
<li>Spell out numbers one through ten. For larger numbers, use numerals.</li>

Change to: "Unless a number begins a sentence, use numerals as opposed to spelling the word out", per Stephanie's recommendation.

@miriamseely
Copy link
Collaborator

@steveoh I've added in a few notes from Stephanie for the style guide, otherwise I think we're good to go! The only thing I might consider changing, aesthetics wise, is indenting some of the sub-bullet points further in (like the ones that are an example of a previously stated point). I think that would make them look more like a sub-point, and not just that the bullets got a little funky. I like the separation with the colors, I think it looks great overall.

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