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

Style checking with Vale #227

Closed
wants to merge 32 commits into from
Closed

Style checking with Vale #227

wants to merge 32 commits into from

Conversation

timothymcmackin
Copy link
Collaborator

@timothymcmackin timothymcmackin commented Dec 27, 2023

Vale can help us be consistent and catch phrases that we do not intend to use. This PR adds a Vale check to the build of all PRs via a github action.

It checks these things:

  • Spelling in general
  • Spelling of specific Tezos-related words (in test/styles/Vocab/Tezos/accept.txt)
  • Capitalization of Smart Rollups and smart contracts
  • Flagging terms such as "ICO" and "investors," which should not be used

We can add and expand these rules as we make decisions about how to talk about Tezos.

TODOs:

  • Work out why it flags capitalized terms at the beginning of sentence, like when we put "Tez" at the start of a sentence.
  • Test with PRs

For more information about Vale, see https://vale.sh.
Due to errata-ai/vale#744 sometimes it misses issues due to capitalization, but I think I have this fixed for the main capitalization issue: Smart Rollups.

@timothymcmackin timothymcmackin self-assigned this Dec 27, 2023
@timothymcmackin timothymcmackin requested a review from a team as a code owner December 27, 2023 16:34
Copy link

vercel bot commented Dec 27, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
docs-staging ✅ Ready (Inspect) Visit Preview Feb 7, 2024 1:59pm

beatalipska
beatalipska previously approved these changes Jan 19, 2024
Copy link
Contributor

@beatalipska beatalipska left a comment

Choose a reason for hiding this comment

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

💪🏻

@timothymcmackin
Copy link
Collaborator Author

Stale; closing.

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