diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml new file mode 100644 index 0000000..22fdec2 --- /dev/null +++ b/.github/workflows/codespell.yml @@ -0,0 +1,23 @@ +# Codespell configuration is within pyproject.toml +--- +name: Codespell + +on: + push: + branches: [main] + pull_request: + branches: [main] + +permissions: + contents: read + +jobs: + codespell: + name: Check for spelling errors + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v6 + - name: Codespell + uses: codespell-project/actions-codespell@8f01853be192eb0f849a5c7d721450e7a467c579 # v2.2 diff --git a/README.md b/README.md index e6e68a4..6c57768 100644 --- a/README.md +++ b/README.md @@ -26,4 +26,4 @@ Then, open your browser to http://localhost:8080. ## Contributing -Contibutions are welcome through pull requests. Please notify the BBQS EMBER team for review. +Contributions are welcome through pull requests. Please notify the BBQS EMBER team for review. diff --git a/docs/example-standardization-and-reproducibility/Suthana_Zenodo.md b/docs/example-standardization-and-reproducibility/Suthana_Zenodo.md index 63a7c86..c6059dc 100644 --- a/docs/example-standardization-and-reproducibility/Suthana_Zenodo.md +++ b/docs/example-standardization-and-reproducibility/Suthana_Zenodo.md @@ -33,7 +33,7 @@ Each variable within the .mat files was then converted into the appropriate moda The current version of the conversion script is located at https://github.com/brain-bbqs/reproforce/blob/main/suthana/Suthana_Zenodo_Conversion.py. -## Verfication +## Verification To verify that the original data was properly converted into NWB, we checked whether the NWB data could be used to replicate the MATLAB code and resulting figures. diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md index 0f0d77b..4528a0e 100644 --- a/docs/getting-started/index.md +++ b/docs/getting-started/index.md @@ -14,10 +14,10 @@ The EMBER Archive supports free storage and sharing of public neurophysiological 2. Register on EMBER - Navigate to the EMBER-DANDI [portal](https://dandi.emberarchive.org/) and click the Login button in the top right corner. 3. Account Review and Approval - - After registering, you will receive an email confirming that your accounr is under review. - - While we try to review and approve accounts as soon as possible, this is a manual process and some reviews may take an extended time, especially for new GitHub acounts or non .edu email addresses. + - After registering, you will receive an email confirming that your account is under review. + - While we try to review and approve accounts as soon as possible, this is a manual process and some reviews may take an extended time, especially for new GitHub accounts or non .edu email addresses. 4. Access EMBER - - Upon approal, you will be able to access EMBER by logging in through the Login button in the top right corner. + - Upon approval, you will be able to access EMBER by logging in through the Login button in the top right corner. For support or questions, please reach out to [help@emberarchive.org](mailto:help@emberarchive.org) diff --git a/docs/user-guide/dandi-cli.md b/docs/user-guide/dandi-cli.md index 0293ba8..121399c 100644 --- a/docs/user-guide/dandi-cli.md +++ b/docs/user-guide/dandi-cli.md @@ -1,6 +1,6 @@ # Getting Started with the DANDI Client -In thes instructions, you will install Python 3.9+ and then install the DANDI Python Client. +In these instructions, you will install Python 3.9+ and then install the DANDI Python Client. ## Quick Steps diff --git a/docs/user-guide/embervault-uploading-data.md b/docs/user-guide/embervault-uploading-data.md index c104a29..31ba120 100644 --- a/docs/user-guide/embervault-uploading-data.md +++ b/docs/user-guide/embervault-uploading-data.md @@ -14,7 +14,7 @@ Your team will standardize and validate data client side, then upload to the EMB ### Account Setup !!! Pre-Requisite - You will need to have an active Globus account, which can usually be obtained through your academic instituion. + You will need to have an active Globus account, which can usually be obtained through your academic institution. 1. Request access to EMBER-Vault by contacting EMBER admins. You will be asked to provide information and reasoning as to why you need an EMBER-Vault account which will be used to determine your eligibility 2. If and when your account is approved, EMBER admins will contact you providing your EMBER-Vault username and temporary password as well as the name of your EMBER-Vault project collection diff --git a/pyproject.toml b/pyproject.toml index ff6dcb1..b26b23b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -9,3 +9,11 @@ dependencies = [ "mkdocs-material>=9.7.0", "pymdown-extensions>=10.17.1", ] + +[tool.codespell] +# Ref: https://github.com/codespell-project/codespell#using-a-config-file +skip = '.git,.git-meta,.gitignore,.gitattributes,*.lock,*.css' +check-hidden = true +# ignore-regex = '' +# shure - Shure (microphone brand, e.g. "Shure SM7B") +ignore-words-list = 'shure'