Skip to content

Commit

Permalink
Add codespell
Browse files Browse the repository at this point in the history
  • Loading branch information
adamltyson committed Feb 15, 2024
1 parent f62293a commit 249b105
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 2 deletions.
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
Expand Up @@ -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:
Expand Down
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
Expand Up @@ -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
Expand Down Expand Up @@ -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.

0 comments on commit 249b105

Please sign in to comment.