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.

Sign up for GitHub

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

Jump to bottom

updates readme #60

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

updates readme #60

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 4 additions & 13 deletions spelling/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,15 +48,13 @@ Vale is highly customizable and the boilerplate styles may not be what you need.

Finally, there are more nuanced Consensys-specific styles such as substitutions, acronym overrides, and other configurations in the [Consensys Style folder](./styles/Consensys).

The [vale.ini](vale.ini) file provides various switches to turn styles on and off and to set what file types are formatted. Furthermore, as part of the GHA, the downstream repos that use this can specify which folders Vale may lint.

## To do
The [vale.ini](.vale.ini) file provides various switches to turn styles on and off and to set what file types are formatted. Furthermore, as part of the GHA, the downstream repos that use this can specify which folders Vale may lint.

## Vale and YAML

Vale might need a parser to handle linting YAMLs (e.g., PyYAML, ruyaml). Then update the `.vale.ini` file to include the YAML style guide and specify the file extensions to lint.
Vale needs a parser to handle linting YAMLs. This is (possibly/probably) why there is an additional ini file [vale-star.ini](vale-star.ini).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@joshuafernandes no longer convinced this is so -- looking at your vale-star.ini, did you actually apply parser too or did you just manage to tell Vale to look a YAML files?! If the latter, there is no need to duplicate the file is there --> as in, we should just be able to add file types to lint as list or array??


### Incorporate `project-words.txt` from repos
### Incorporated `project-words.txt` from repos

Bash NOT GPT

Expand All @@ -82,19 +80,12 @@ Bash NOT GPT

## Test this

title should trigger
ConsenSys should trigger

Should trigger:

With off brand Metamask
′
″
zk-EVM
goerli
Goerli
on-chain


Shouldn't trigger

booleans
Expand Down