diff --git a/.codespellignore b/.codespellignore new file mode 100644 index 00000000000..8e35e0d54a9 --- /dev/null +++ b/.codespellignore @@ -0,0 +1,2 @@ +FORRT +COS diff --git a/.github/workflows/check_typos.yml b/.github/workflows/check_typos.yml new file mode 100644 index 00000000000..c284346cd14 --- /dev/null +++ b/.github/workflows/check_typos.yml @@ -0,0 +1,19 @@ +on: + pull_request: + branches: + - master + +name: Check typos +jobs: + codespell: + name: Discover typos with codespell + runs-on: ubuntu-latest + strategy: + fail-fast: false + steps: + - uses: actions/checkout@v3 + - uses: codespell-project/actions-codespell@master + with: + skip: "*.yml,*.py,*.toml,*.css, *.geojson, *.pdf" + ignore_words_file: .codespellignore + only_warn: 1 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9b1942d8d7d..77945f9d038 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -56,7 +56,7 @@ A way to run the project locally without installing Hugo on the host machine is 2. Open `.devcontainer/devcontainer.json` in VSCode. If you are on a Windows host, go to `.devcontainer\dev\devcontainer.json` and uncomment the line `"remoteUser": "root"` before continuing. 3. In the context menu of VSCode (Crl + Shift + P), select `Dev Containers: Open Folder in Container`. Alternatively, a pop-up will appear in the bottom right corner of the window asking if you want to open the folder in a container. Click on `Reopen in Container`. 4. Wait for the container to build. The context of VS Code will change. In the bottom left corner, you will see a green icon with the name of the container (Hugo Dev). -5. Run `hugo server -D`. The container will foward port 1313 to the host machine, so you can access the website at `http://localhost:1313`. +5. Run `hugo server -D`. The container will forward port 1313 to the host machine, so you can access the website at `http://localhost:1313`. ### Development - R-Studio @@ -91,4 +91,4 @@ To edit it locally, you will then need to: 8. Then you can push this branch to GitHub. 9. Create a pull request to the original FORRT repo. -Please note that RStudio is not designed for website development, so you may find it easier to use the Dev Containers method described above. \ No newline at end of file +Please note that RStudio is not designed for website development, so you may find it easier to use the Dev Containers method described above.