Skip to content

Add Vale for writing consistency#172

Open
Sporiff wants to merge 1 commit intomainfrom
add-vale
Open

Add Vale for writing consistency#172
Sporiff wants to merge 1 commit intomainfrom
add-vale

Conversation

@Sporiff
Copy link
Copy Markdown
Member

@Sporiff Sporiff commented Mar 15, 2026

Currently, we don't have any checks in place on our writing style or conventions. To make this easier, this PR adds Vale rules that can be used in any editor to validate that writing is consistent and follows best practice.

@Sporiff Sporiff self-assigned this Mar 15, 2026
@netlify
Copy link
Copy Markdown

netlify bot commented Mar 15, 2026

Deploy Preview for openpodcastapi ready!

Name Link
🔨 Latest commit b6021f6
🔍 Latest deploy log https://app.netlify.com/projects/openpodcastapi/deploys/69b72b441bb17100084ac158
😎 Deploy Preview https://deploy-preview-172--openpodcastapi.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copy link
Copy Markdown
Member

@keunes keunes left a comment

Choose a reason for hiding this comment

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

Interesting :-)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

My European heart says: we should recommend using 24hr notation instead :P

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@keunes We can put an override in for that.

@@ -0,0 +1,9 @@
extends: existence
message: "Use 'July 31, 2016' format, not '%s'."
Copy link
Copy Markdown
Member

@keunes keunes Mar 26, 2026

Choose a reason for hiding this comment

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

Is there a European variant of this? (31 July 2016) :P

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@keunes We can override it if needs be. I would always just use 2016-07-31 myself.

@@ -0,0 +1,29 @@
extends: capitalization
message: "'%s' should use sentence-style capitalization."
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Will this not trigger warnings if we use things like POST in a heading?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@keunes Yes, we can create an allowlist override for that (e.g. ignore rules like this for HTTP verbs like GET/POST). I usually just update rules while I'm writing if I disagree with them.

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