Skip to content

Configure codespell pre-commit hook for spell checking #152

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

Merged
merged 10 commits into from
Sep 18, 2024
Merged
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
17 changes: 17 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -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$'
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,29 @@ $ GIT_USER=<Your GitHub username> 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
```
4 changes: 2 additions & 2 deletions src/components/about/Team/Ian.md
Original file line number Diff line number Diff line change
@@ -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 <a href="https://github.com/bokeh/bokeh">Bokeh</a>, a library for interactive visualisation in web browsers, and the lead maintainer of <a href="https://github.com/contourpy/contourpy">ContourPy</a>, a Python/C++ library for calculating contours. He has also made significant contributions to <a href="https://github.com/matplotlib/matplotlib">Matplotlib</a> and <a href="https://github.com/holoviz/datashader">Datashader</a>.
Ian has many years' experience as an open-source contributor. He is a core maintainer of <a href="https://github.com/bokeh/bokeh">Bokeh</a>, a library for interactive visualization in web browsers, and the lead maintainer of <a href="https://github.com/contourpy/contourpy">ContourPy</a>, a Python/C++ library for calculating contours. He has also made significant contributions to <a href="https://github.com/matplotlib/matplotlib">Matplotlib</a> and <a href="https://github.com/holoviz/datashader">Datashader</a>.
2 changes: 1 addition & 1 deletion src/components/about/Team/Joel.md
Original file line number Diff line number Diff line change
@@ -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 (<a href="https://www.softbankrobotics.com/">Softbank-Robotics/Aldebaran</a>), "heavy" interractive web apps (<a href="https://jellynote.com">https://jellynote.com</a> 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 (<a href="https://www.softbankrobotics.com/">Softbank-Robotics/Aldebaran</a>), "heavy" interactive web apps (<a href="https://jellynote.com">https://jellynote.com</a> 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 <a href="https://build2.org">build2</a>) and the <a href="https://webassembly.org/">WebAssembly</a> platform.

Expand Down
2 changes: 1 addition & 1 deletion src/components/about/styles.module.css
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
}

.small_portrait_card:hover {
border: solid 1px grey;
border: solid 1px gray;
cursor: pointer;
text-decoration: #0000EE underline;
}
Expand Down
2 changes: 1 addition & 1 deletion src/components/blog/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/components/blog/blogpostsDetails.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion src/components/contact/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export function Contact() {
<ContactIllustration
height={"460px"}
alt={
"Illustration for the contact page with a woman, a mobile phone and an enveloppe."
"Illustration for the contact page with a woman, a mobile phone and an envelope."
}
/>
</div>
Expand Down
6 changes: 3 additions & 3 deletions src/components/home/Hero/styles.module.css
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
}

.pydata_informations {
color: grey;
color: gray;
font-size: 12px;
font-weight: 600;
position: absolute;
Expand Down Expand Up @@ -70,7 +70,7 @@
}

.pydata_informations {
color: grey;
color: gray;
font-size: var(--ifm-font-size-small);
font-weight: 600;
position: absolute;
Expand Down Expand Up @@ -132,7 +132,7 @@
}

.pydata_informations {
color: grey;
color: gray;
font-size: var(--ifm-font-size-medium);
font-weight: 600;
position: absolute;
Expand Down
2 changes: 1 addition & 1 deletion src/components/home/WhatWeDo/topics/Computing.md
Original file line number Diff line number Diff line change
@@ -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.
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.
2 changes: 1 addition & 1 deletion src/components/projects/descriptions/Header.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down