Skip to content

Conversation

eshanrnh
Copy link
Contributor

📋 Description

Added config files to check for spelling in incoming PRs.

How to test:

  1. Add the following files to your forked repo:
.github/styles/UmbracoSpelling/Spelling.yml 
.github/styles/config/dictionaries/en_US.aff 
.github/styles/config/dictionaries/en_US.dic 
.github/styles/config/dictionaries/umbraco.aff 
.github/styles/config/dictionaries/umbraco.dic
  1. Create a PR with spelling issues.
  2. The typos should show an inline comment like below:
image

📎 Related Issues (if applicable)

✅ Contributor Checklist

I've followed the Umbraco Documentation Style Guide and can confirm that:

  • Code blocks are correctly formatted.
  • Sentences are short and clear (preferably under 25 words).
  • Passive voice and first-person language (“we”, “I”) are avoided.
  • Relevant pages are linked.
  • All links work and point to the correct resources.
  • Screenshots or diagrams are included if useful.
  • Any code examples or instructions have been tested.
  • Typos, broken links, and broken images are fixed.

Product & Version (if relevant)

Deadline (if relevant)

Anytime

📚 Helpful Resources

@eshanrnh eshanrnh requested a review from sofietoft September 15, 2025 13:11
@eshanrnh
Copy link
Contributor Author

If the message is not clear, there are other options too:

  • "'%s' is a typo!"
  • "Did you really mean '%s'?"

Any other suggestion?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants