diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 000000000..4596f70e6 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,17 @@ +ci: + autoupdate_schedule: monthly + autofix_prs: true + +repos: + # Codespell hook configuration + - repo: https://github.com/codespell-project/codespell + rev: v2.3.0 + hooks: + - id: codespell + name: Spell Check with Codespell + args: + - '--write-changes' + - '--ignore-words-list=cppp,normale' + - '--builtin=en-GB_to_en-US' + # Exclude package-lock.json and all .svg files + exclude: 'package-lock\.json|\.svg$' diff --git a/README.md b/README.md index 0c6c2c27b..71a13ce02 100644 --- a/README.md +++ b/README.md @@ -39,3 +39,29 @@ $ GIT_USER= yarn deploy ``` If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. + +### Pre-commit Hook Setup + +To ensure code quality and consistency, we use `pre-commit` hooks. Here's how to set up and run the pre-commit hook locally: + +1. **Install pre-commit:** + + If `pre-commit` isn't already installed, you can install it using `pip`: + + ```bash + $ pip install pre-commit + ``` +2. **Install the pre-commit hooks:** + + Once `pre-commit` is installed, set up the hooks for the repository by running: + + ```bash + $ pre-commit install + ``` +3. **Run pre-commit hooks manually:** + + To run the `pre-commit` hooks on all files manually, use: + + ```bash + $ pre-commit run --all-files + ``` diff --git a/src/components/about/Team/Ian.md b/src/components/about/Team/Ian.md index 41b80e961..1d69c7ff7 100644 --- a/src/components/about/Team/Ian.md +++ b/src/components/about/Team/Ian.md @@ -1,5 +1,5 @@ Ian Thomas is a Scientific Software Developer at QuantStack. He holds a BA in Physics from Oxford University and PhD in ocean modeling from the University of Southampton. -He has particular interest in data analysis and visualisation, leaning towards solving mathematical and geometric problems. +He has particular interest in data analysis and visualization, leaning towards solving mathematical and geometric problems. -Ian has many years' experience as an open-source contributor. He is a core maintainer of Bokeh, a library for interactive visualisation in web browsers, and the lead maintainer of ContourPy, a Python/C++ library for calculating contours. He has also made significant contributions to Matplotlib and Datashader. +Ian has many years' experience as an open-source contributor. He is a core maintainer of Bokeh, a library for interactive visualization in web browsers, and the lead maintainer of ContourPy, a Python/C++ library for calculating contours. He has also made significant contributions to Matplotlib and Datashader. diff --git a/src/components/about/Team/Joel.md b/src/components/about/Team/Joel.md index 36f497e19..fa13d7033 100644 --- a/src/components/about/Team/Joel.md +++ b/src/components/about/Team/Joel.md @@ -1,4 +1,4 @@ -Before joining QuantStack, Joël worked since 2003 in various companies covering a large spectre of domains all dominated by performance constraints: games, embedded software of all sorts, robotics (Softbank-Robotics/Aldebaran), "heavy" interractive web apps (https://jellynote.com score player for example)... +Before joining QuantStack, Joël worked since 2003 in various companies covering a large spectre of domains all dominated by performance constraints: games, embedded software of all sorts, robotics (Softbank-Robotics/Aldebaran), "heavy" interactive web apps (https://jellynote.com score player for example)... Through the years Joël participated to various open-source projects with, in recent years, a particular focus on dependency management for C++ projects (like build2) and the WebAssembly platform. diff --git a/src/components/about/styles.module.css b/src/components/about/styles.module.css index a69f5addf..5bad741be 100644 --- a/src/components/about/styles.module.css +++ b/src/components/about/styles.module.css @@ -10,7 +10,7 @@ } .small_portrait_card:hover { - border: solid 1px grey; + border: solid 1px gray; cursor: pointer; text-decoration: #0000EE underline; } diff --git a/src/components/blog/_config.yml b/src/components/blog/_config.yml index 7aae38ec6..fabb6ff46 100644 --- a/src/components/blog/_config.yml +++ b/src/components/blog/_config.yml @@ -538,7 +538,7 @@ blog: authors: Mariana Meireles - url: https://blog.jupyter.org/a-visual-debugger-for-jupyter-914e61716559 - title: A Visual Debuger for Jupyter + title: A Visual Debugger for Jupyter image: https://miro.medium.com/max/933/0*9pVDg58cTz5Yezw8.gif summary: Most of the progress made in software projects comes from incrementalism. The ability to quickly see the outcome of an execution and iterate has been one of the main reasons for the success of… date: Mar 25, 2020 diff --git a/src/components/blog/blogpostsDetails.json b/src/components/blog/blogpostsDetails.json index 7fd019665..a69e1989a 100644 --- a/src/components/blog/blogpostsDetails.json +++ b/src/components/blog/blogpostsDetails.json @@ -1015,7 +1015,7 @@ }, { "url": "https://blog.jupyter.org/a-visual-debugger-for-jupyter-914e61716559", - "title": "A Visual Debuger for Jupyter", + "title": "A Visual Debugger for Jupyter", "image": "/img/blogposts/A-Visual-Debuger-for-Jupyter.gif", "summary": "Most of the progress made in software projects comes from incrementalism. The ability to quickly see the outcome of an execution and iterate has been one of the main reasons for the success of…", "date": "Mar 25, 2020", diff --git a/src/components/contact/index.tsx b/src/components/contact/index.tsx index a5d13c041..eb0614f2d 100644 --- a/src/components/contact/index.tsx +++ b/src/components/contact/index.tsx @@ -17,7 +17,7 @@ export function Contact() { diff --git a/src/components/home/Hero/styles.module.css b/src/components/home/Hero/styles.module.css index b0f4a97a8..3e8a01372 100644 --- a/src/components/home/Hero/styles.module.css +++ b/src/components/home/Hero/styles.module.css @@ -36,7 +36,7 @@ } .pydata_informations { - color: grey; + color: gray; font-size: 12px; font-weight: 600; position: absolute; @@ -70,7 +70,7 @@ } .pydata_informations { - color: grey; + color: gray; font-size: var(--ifm-font-size-small); font-weight: 600; position: absolute; @@ -132,7 +132,7 @@ } .pydata_informations { - color: grey; + color: gray; font-size: var(--ifm-font-size-medium); font-weight: 600; position: absolute; diff --git a/src/components/home/WhatWeDo/topics/Computing.md b/src/components/home/WhatWeDo/topics/Computing.md index 8294dffed..265bd725e 100644 --- a/src/components/home/WhatWeDo/topics/Computing.md +++ b/src/components/home/WhatWeDo/topics/Computing.md @@ -1 +1 @@ -We created several popular scientific computing packages. XSimd, an unified API for SIMD opreations, adopted by projects such as Apache Arrox, FireFox, Kytra, Pythran... Xtensor, a C++ n-dimensional array librairy with broadcasting and lazy evaluation. \ No newline at end of file +We created several popular scientific computing packages. XSimd, an unified API for SIMD operations, adopted by projects such as Apache Arrox, FireFox, Kytra, Pythran... Xtensor, a C++ n-dimensional array library with broadcasting and lazy evaluation. \ No newline at end of file diff --git a/src/components/projects/descriptions/Header.md b/src/components/projects/descriptions/Header.md index 4a3a9b0b0..1c87c9b4f 100644 --- a/src/components/projects/descriptions/Header.md +++ b/src/components/projects/descriptions/Header.md @@ -5,5 +5,5 @@ from data sciences to robotics. Open-source development is a unique way to break down collaboration barriers and reach users with -unexpected use cases. Enabling customisation and extensions of the +unexpected use cases. Enabling customization and extensions of the tools enables this diversity of applications. diff --git a/src/css/custom.css b/src/css/custom.css index 5eeaa778b..193974f2e 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -30,7 +30,7 @@ --ifm-text-color-footer: black; /*popup overlay*/ - --ifm-background-color-popup-overlay: grey; + --ifm-background-color-popup-overlay: gray; /* Font sizes */ --ifm-font-size-small: 14px;