Ask people to run a grammar check prior to PR, and to use US English

[mikemaccana]

IIRC you suggested this yesterday, it was a good idea.

[mikemaccana]

lol Code style issues found in the above file. Run Prettier to fix. 😁

[mikemaccana]

@nickfrosty can we disable prettier (with a view to having it be run by github actions in future) or do you want us to pull anything we edit on github down to our local machines, run prettier, and reupload?

[nickfrosty]

@mikemaccana no we will not disable it: https://github.com/solana-foundation/developer-content/blob/main/CONTRIBUTING.md#prettier

[jacobcreech]

Can we just recommend to use the grammarly app for checking english instead of a vscode extension? Not everyone uses vscode but everyone uses a browser.

[mikemaccana]

Can we just recommend to use the grammarly app for checking english instead of a vscode extension? Not everyone uses vscode but everyone uses a browser.

I like the addition, but let's move this further to the top of the document. Since this repo is basically all written content, it makes more sense to make this more of a focus.

Yep. I'll merge this into my other PR, one moment...

Also: run prettier :)

The reason I asked you about fixing the tests is the previous conversation we'd had about how the github editor doesn't run prettier, and having the test fail stops people being able to quickly fix anything using the github editor - exactly like it has here!

Currently:

• Edit code on github (super common for people fixing typos or grammatical errors)
• Tests fail
• User has to clone branch manually
• Reopen file and run prettier
• Commit again

Proposing:

• Edit code on github (super common for people fixing typos or grammatical errors)

As we discussed the proper thing to do is have github actions run prettier and do a commit with prettier, which I think you were planning on getting working.

[mikemaccana]

Merged into https://github.com/solana-foundation/developer-content/pull/201