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.

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

Add codespell to catch common spelling mistakes #90

Merged
merged 3 commits into from
Feb 15, 2024
Merged
Changes from 1 commit
Commits
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
3 changes: 3 additions & 0 deletions .codespellrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[codespell]
skip = '.git'
check-hidden = true
8 changes: 8 additions & 0 deletions .github/workflows/docs_build_and_deploy.yml
Original file line number Diff line number Diff line change
@@ -15,7 +15,15 @@ on:
workflow_dispatch:

jobs:
linting:
# scheduled workflows should not run on forks
if: (${{ github.event_name == 'schedule' }} && ${{ github.repository_owner == 'neuroinformatics-unit' }} && ${{ github.ref == 'refs/heads/main' }}) || (${{ github.event_name != 'schedule' }})
runs-on: ubuntu-latest
steps:
- uses: neuroinformatics-unit/actions/lint@v1

build_sphinx_docs:
needs: linting
name: Build Sphinx Docs
runs-on: ubuntu-latest
steps:
11 changes: 11 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Configuring https://pre-commit.ci/
ci:
autoupdate_schedule: monthly

exclude: "conf.py"

repos:
- repo: https://github.com/codespell-project/codespell
rev: v2.2.6
hooks:
- id: codespell
4 changes: 2 additions & 2 deletions docs/source/guidelines/languages_frameworks.md
Original file line number Diff line number Diff line change
@@ -30,7 +30,7 @@ code style.
### Continuous integration
* All pushes and pull requests will be built by [GitHub actions](https://docs.github.com/en/actions). This will usually include linting, testing and deployment.
* As a rule, actions will run on all operating systems (Linux, macOS, Windows) and on all Python versions that are supported by the project.
* GitHub actions workflows should be contributed to the [NIU actions repository](https://github.com/neuroinformatics-unit/actions) to aid re-use.
* GitHub actions workflows should be contributed to the [NIU actions repository](https://github.com/neuroinformatics-unit/actions) to aid reuse.

### Automated versioning
We use [`setuptools_scm`](https://github.com/pypa/setuptools_scm) to automatically version packages. It should be
@@ -79,5 +79,5 @@ User-editable configuration files should use the YAML format. As far as possible

### Release
* All Python software should be released on PyPI to enable a simple `pip install`. At a minimum, each project should
* have two owners - [Adam (adamltyson)](https://github.com/adamltyson) and the lead developer. Others can be added as owners/maintainers as appropriate.
* Have two owners - [Adam (adamltyson)](https://github.com/adamltyson) and the lead developer. Others can be added as owners/maintainers as appropriate.
* We will also aim to release projects on [conda-forge](https://conda-forge.org/), especially for packages with non-Python dependencies.