Skip to content

Commit 6ffac67

Browse files
TraceyC77Tracey Clark
and
Tracey Clark
authored
Add markdown standards (#349)
Co-authored-by: Tracey Clark <[email protected]>
1 parent 4a38554 commit 6ffac67

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,13 @@ To get started developing our Docusaurus instance, or writing documentation, fir
2020

2121
This project is written using [TypeScript](https://www.typescriptlang.org) and [React](https://reactjs.org), with some documentation being Markdown or [MDX](https://mdxjs.com/). To facilitate development, we use nvm and Yarn.
2222

23+
Please lint and spellcheck your updates before creating a pull request. We recommend VS Code with the "prettier" extension for linting. You are free to use whatever software and linters you prefer as long as they get the job done.
24+
25+
### Markdown
26+
27+
We recommend "Code Spell Checker" or `codespell` for spell checking.
28+
Codespell is available for installation `sudo eopkg install codespell`
29+
2330
### NVM
2431

2532
To set up nvm, the Node Version Manager, follow the instructions listed [here](https://github.com/nvm-sh/nvm#readme). We recommend [setting up their shell integration](https://github.com/nvm-sh/nvm#deeper-shell-integration) as well, so you can automatically switch to the correct Node version when working on this project. Otherwise, ensure you run `nvm use`. This project requires the "current" supported release series of Node.

0 commit comments

Comments
 (0)