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

feat: Add pre-commit config #1017

Open
wants to merge 4 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
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
6 changes: 3 additions & 3 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: curvenote
on:
pull_request:
branches: ['2024']
branches: ["2024"]
permissions:
contents: read
pull-requests: write
Expand All @@ -10,12 +10,12 @@ jobs:
uses: curvenote/actions/.github/workflows/publish.yml@v1
with:
monorepo: true
id-pattern-regex: '^scipy-2024-(?:[a-zA-Z0-9-_]{3,15})$'
id-pattern-regex: "^scipy-2024-(?:[a-zA-Z0-9-_]{3,15})$"
enforce-single-folder: paper
preview-label: paper
submit-label: true
venue: scipy
collection: '2024'
collection: "2024"
kind: Article
path: papers/*
secrets:
Expand Down
44 changes: 44 additions & 0 deletions .pre-commit-config.yaml
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would also benefit from codespell-project/codespell being added (c.f. https://github.com/scipy-conference/scipy-conference/blob/3755b74eb94a00ca7038b5210f01f021b5127e72/.pre-commit-config.yaml#L30-L38) but given that there are multiple words that need to get added to an ignore list and fixed in files, I've decided to not do that in this PR. as it would need some input from other parties.

Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
ci:
autoupdate_commit_msg: "chore: [pre-commit.ci] pre-commit autoupdate"
autoupdate_schedule: quarterly

repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.6.0
hooks:
- id: check-case-conflict
- id: check-json
- id: check-merge-conflict
- id: check-symlinks
- id: check-xml
- id: check-yaml
- id: debug-statements
- id: end-of-file-fixer
exclude: >
(?x)^(
.*\.csv
)$
- id: mixed-line-ending
exclude: >
(?x)^(
.*\.csv|
.*\.css
)$
- id: requirements-txt-fixer
- id: trailing-whitespace
exclude: >
(?x)^(
.*\.csv
)$

- repo: https://github.com/python-jsonschema/check-jsonschema
rev: 0.29.1
hooks:
- id: check-github-workflows
args: ["--verbose"]
matthewfeickert marked this conversation as resolved.
Show resolved Hide resolved

- repo: https://github.com/pre-commit/mirrors-prettier
rev: v3.1.0
hooks:
- id: prettier
types_or: [yaml, html, css, scss, javascript, json, toml]
1 change: 0 additions & 1 deletion papers/00_bibderwalt/00_bibderwalt.rst
Original file line number Diff line number Diff line change
Expand Up @@ -341,4 +341,3 @@ proceedings editors.
:usepackage: somepackage

Some custom LaTeX source here.

1 change: 0 additions & 1 deletion papers/00_texderwalt/00_texderwalt.tex
Original file line number Diff line number Diff line change
Expand Up @@ -281,4 +281,3 @@ \subsection{Important Part \label{important-part}}
\emph{Muddy water, let stand, becomes clear.}
\end{quote}
\end{quotation}

40 changes: 20 additions & 20 deletions papers/00_texderwalt/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
---
abstract:
- A short version of the long version that is way too long to be written as a short version anyway. Still, when considering the facts from first principles, we find that the outcomes of this introspective approach is compatible with the guidelines previously established.
- In such an experiment it is then clear that the potential for further development not only depends on previous relationships found but also on connections made during exploitation of this novel new experimental protocol.
- A short version of the long version that is way too long to be written as a short version anyway. Still, when considering the facts from first principles, we find that the outcomes of this introspective approach is compatible with the guidelines previously established.
- In such an experiment it is then clear that the potential for further development not only depends on previous relationships found but also on connections made during exploitation of this novel new experimental protocol.
keywords:
- terraforming
- desert
- numerical perspective
authors:
- email: [email protected]
institution:
- Senate House, S.P.Q.R.
- Egyptian Embassy, S.P.Q.R.
name: Gaius Caesar
- email: [email protected]
institution:
- Egyptian Embassy, S.P.Q.R.
name: Mark Anthony
- email: [email protected]
institution:
- Egyptian Embassy, S.P.Q.R.
- Yet another place, S.P.Q.R.
name: Jarrod Millman
corresponding: true
- email: [email protected]
name: Cleopatra
- email: [email protected]
institution:
- Senate House, S.P.Q.R.
- Egyptian Embassy, S.P.Q.R.
name: Gaius Caesar
- email: [email protected]
institution:
- Egyptian Embassy, S.P.Q.R.
name: Mark Anthony
- email: [email protected]
institution:
- Egyptian Embassy, S.P.Q.R.
- Yet another place, S.P.Q.R.
name: Jarrod Millman
corresponding: true
- email: [email protected]
name: Cleopatra
bibliography: mybib
video: "https://www.youtube.com/watch?v=Hz1JWzyvv8A"
title: A Numerical Perspective to Terraforming a Desert -- latex edition
title: A Numerical Perspective to Terraforming a Desert -- latex edition
18 changes: 9 additions & 9 deletions presentations/lightning/example/info.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"title": "Introducing JOSE: Journal of Open Source Education",
"authors": [
{
"name": "Kyle Niemeyer",
"affiliation": "Oregon State University",
"orcid": "0000-0003-4425-7097"
}
],
"description": "A cool presentation about a cooler open source journal"
"title": "Introducing JOSE: Journal of Open Source Education",
"authors": [
{
"name": "Kyle Niemeyer",
"affiliation": "Oregon State University",
"orcid": "0000-0003-4425-7097"
}
],
"description": "A cool presentation about a cooler open source journal"
}
28 changes: 14 additions & 14 deletions presentations/posters/example/info.json
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
{
"authors": [
{
"name": "First Author",
"affiliation": "First Author's Institution",
"orcid": "0101-0101-0101-0103"
},
{
"name": "Second Author",
"affiliation": "Second Author's Company",
"orcid": "0202-0211-0101-0141"
}
],
"title": "A test title",
"description": "A brief description of what this object is"
"authors": [
{
"name": "First Author",
"affiliation": "First Author's Institution",
"orcid": "0101-0101-0101-0103"
},
{
"name": "Second Author",
"affiliation": "Second Author's Company",
"orcid": "0202-0211-0101-0141"
}
],
"title": "A test title",
"description": "A brief description of what this object is"
}
18 changes: 9 additions & 9 deletions presentations/slides/example/info.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"title": "Safe handling instructions for missing data",
"authors": [
{
"name": "Dillon Niederhut",
"affiliation": "Enthought, Inc.",
"orcid": "0000-0002-9995-4378"
}
],
"description": "A presentation about what to do with missing data"
"title": "Safe handling instructions for missing data",
"authors": [
{
"name": "Dillon Niederhut",
"affiliation": "Enthought, Inc.",
"orcid": "0000-0002-9995-4378"
}
],
"description": "A presentation about what to do with missing data"
}
18 changes: 9 additions & 9 deletions presentations/tools/example/info.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"title": "SciPy Tools Plenary on Mayavi",
"authors": [
{
"name": "Prabhu Ramachandran",
"affiliation": "Department of Aerospace Engineering, IIT, Bombay",
"orcid": "0000-0001-6337-1720"
}
],
"description": "2018 updates in Mayavi, a 3D plotting application"
"title": "SciPy Tools Plenary on Mayavi",
"authors": [
{
"name": "Prabhu Ramachandran",
"affiliation": "Department of Aerospace Engineering, IIT, Bombay",
"orcid": "0000-0001-6337-1720"
}
],
"description": "2018 updates in Mayavi, a 3D plotting application"
}
4 changes: 2 additions & 2 deletions publisher/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ $(TEXDIR)/%.pdf: $(TEXDIR)/%.tex
title-pdf: $(TEXDIR)/title.pdf
copyright-pdf: $(TEXDIR)/copyright.pdf
organization-pdf: $(TEXDIR)/organization.pdf
students-pdf: $(TEXDIR)/students.pdf
slides-pdf: $(TEXDIR)/slides.pdf
students-pdf: $(TEXDIR)/students.pdf
slides-pdf: $(TEXDIR)/slides.pdf

front-pdf: title-pdf copyright-pdf organization-pdf students-pdf slides-pdf

Expand Down
Loading