diff --git a/.codespellrc b/.codespellrc new file mode 100644 index 0000000..7af18ee --- /dev/null +++ b/.codespellrc @@ -0,0 +1,3 @@ +[codespell] +skip = '.git' +check-hidden = true \ No newline at end of file diff --git a/.github/workflows/docs_build_and_deploy.yml b/.github/workflows/docs_build_and_deploy.yml index eb395b5..e2fd50f 100644 --- a/.github/workflows/docs_build_and_deploy.yml +++ b/.github/workflows/docs_build_and_deploy.yml @@ -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: diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..cd35c4b --- /dev/null +++ b/.pre-commit-config.yaml @@ -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 diff --git a/docs/source/guidelines/languages_frameworks.md b/docs/source/guidelines/languages_frameworks.md index 1552096..89ac0e5 100644 --- a/docs/source/guidelines/languages_frameworks.md +++ b/docs/source/guidelines/languages_frameworks.md @@ -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.