Adding pre-commit + test run

harvard-edge · Feb 4, 2025 · 7a12db3 · 7a12db3
1 parent acabe3b
commit 7a12db3
Show file tree

Hide file tree

Showing 121 changed files with 2,342 additions and 2,347 deletions.
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -572,4 +572,4 @@
     "repoHost": "https://github.com",
     "commitConvention": "angular",
     "skipCi": true
-}
+}
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -2,6 +2,6 @@ Before submitting your Pull Request, please review and complete the items on thi
 
 - [ ] The text has been proofread for grammar and spelling errors.
 - [ ] All images, figures, and tables render properly without any glitches.
-- [ ] All images have a source or they are properly linked to external sites. 
+- [ ] All images have a source or they are properly linked to external sites.
 - [ ] The chapter's formatting is consistent with the rest of the book.
 - [ ] The chapter has been locally built and tested using Quarto.
diff --git a/.github/workflows/auto-add-contributors.yml b/.github/workflows/auto-add-contributors.yml
@@ -36,22 +36,22 @@ jobs:
       run: |
         echo "Using all-contributors CLI to update files"
         npm i -D all-contributors-cli
-        
+
         # Configure Git
         git config --global user.email "github-actions[bot]@users.noreply.github.com"
         git config --global user.name "github-actions[bot]"
-        
+
         # Fetch the latest state of the current branch from the remote
         git fetch origin $GITHUB_REF_NAME
         git reset --hard origin/$GITHUB_REF_NAME
-        
+
         # Run the script
         python .github/workflows/contributors/update_contributors.py
         npx all-contributors generate
-        
+
         # Add updates
         git add -u
-        
+
         # Commit and push if there are changes
         git diff-index --quiet HEAD || git commit -m "Update readme and acknowledgements.qmd with contributors"
         git push

diff --git a/.github/workflows/build_pages_dev.yml b/.github/workflows/build_pages_dev.yml
@@ -29,7 +29,7 @@ jobs:
 
       - name: Install R Packages
         run: Rscript install_packages.R
-        
+
       - name: Install Dependencies
         run: |
           sudo apt-get update
@@ -45,7 +45,7 @@ jobs:
             gdk-pixbuf2.0-bin \
             libgdk-pixbuf2.0-dev \
             librsvg2-bin
-            
+
       - name: Install Inkscape
         run: |
           sudo add-apt-repository ppa:inkscape.dev/stable -y
@@ -55,7 +55,7 @@ jobs:
       - name: Render Quarto Project
         uses: quarto-dev/quarto-actions/render@v2
         with:
-          to: html          
+          to: html
 
       - name: stage files
         uses: cpina/[email protected]

diff --git a/.github/workflows/build_pages_windows.yml b/.github/workflows/build_pages_windows.yml
@@ -26,13 +26,13 @@ jobs:
 
       - name: Install R Packages
         run: Rscript install_packages.R
-        
+
       - name: Install Inkscape (if needed for SVG)
         run: choco install inkscape -y
 
       - name: Render Quarto Project
         uses: quarto-dev/quarto-actions/render@v2
-        
+
       - name: Upload artifact from Windows
         if: ${{ github.event_name == 'pull_request' }}
         uses: actions/upload-artifact@v4

diff --git a/.github/workflows/contributors/requirements.txt b/.github/workflows/contributors/requirements.txt
@@ -1,3 +1,3 @@
 absl-py
 pandas
-PyGithub
+PyGithub
diff --git a/.github/workflows/markdown_linter/.mdlintconfig.yml b/.github/workflows/markdown_linter/.mdlintconfig.yml
@@ -247,4 +247,4 @@ MD054:
   # Allow shortcut reference links and images
   shortcut: true
   # Allow URLs as inline links
-  url_inline: true
+  url_inline: true
diff --git a/.github/workflows/markdown_linter/.mdlintignore b/.github/workflows/markdown_linter/.mdlintignore
@@ -7,4 +7,4 @@ _book/*
 *.json
 LICENSE.md
 CODE_OF_CONDUCT.md
-README.md
+README.md
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,14 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace  # Removes extra spaces
+      - id: end-of-file-fixer    # Ensures a newline at EOF
+      - id: check-yaml           # Checks YAML syntax
+  - repo: local
+    hooks:
+      - id: test-custom-script
+        name: Run test script
+        entry: scripts/test-script.sh
+        language: system
+        types: [file]
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -59,7 +59,7 @@ representative at an online or offline event.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at 
+reported to the community leaders responsible for enforcement at
 [email protected] or [email protected].
 All complaints will be reviewed and investigated promptly and fairly.
 

diff --git a/LICENSE.md b/LICENSE.md
@@ -1,2 +1 @@
 This work is licensed under Attribution-NonCommercial-ShareAlike 4.0 International
-
diff --git a/Machine-Learning-Systems.log b/Machine-Learning-Systems.log
@@ -554,7 +554,7 @@ Package caption Info: sidecap package is loaded.
 
 Class scrbook Warning: Usage of package `fancyhdr' together
 (scrbook)              with a KOMA-Script class is not recommended.
-(scrbook)              I'd suggest to use 
+(scrbook)              I'd suggest to use
 (scrbook)              package `scrlayer' or `scrlayer-scrpage', because
 (scrbook)              they support KOMA-Script classes.
 (scrbook)              With `fancyhdr' several features of class `scrbook'
@@ -577,7 +577,7 @@ Package: fancyhdr 2024/12/09 v4.5 Extensive control of page headers and footers
 \f@nch@O@olf=\skip88
 \f@nch@O@orf=\skip89
 ) (C:\Users\Zeljko\AppData\Local\Programs\MiKTeX\tex/latex/fontspec\fontspec.sty (C:\Users\Zeljko\AppData\Local\Programs\MiKTeX\tex/latex/l3packages/xparse\xparse.sty (C:\Users\Zeljko\AppData\Local\Programs\MiKTeX\tex/latex/l3kernel\expl3.sty
-Package: expl3 2024-11-02 L3 programming layer (loader) 
+Package: expl3 2024-11-02 L3 programming layer (loader)
  (C:\Users\Zeljko\AppData\Local\Programs\MiKTeX\tex/latex/l3backend\l3backend-pdftex.def
 File: l3backend-pdftex.def 2024-05-08 L3 backend support: PDF output (pdfTeX)
 \l__color_backend_stack_int=\count310
@@ -590,16 +590,16 @@ Package: fontspec 2024/05/11 v2.9e Font selection for XeLaTeX and LuaLaTeX
 
 ! Fatal Package fontspec Error: The fontspec package requires either XeTeX or
 (fontspec)                      LuaTeX.
-(fontspec)                      
+(fontspec)
 (fontspec)                      You must change your typesetting engine to,
 (fontspec)                      e.g., "xelatex" or "lualatex" instead of
 (fontspec)                      "latex" or "pdflatex".
 
 Type <return> to continue.
- ...                                              
-                                                  
+ ...
+
 l.101 \msg_fatal:nn {fontspec} {cannot-use-pdftex}
-                                                  
+
 
 LaTeX does not know anything more about this error, sorry.
 
@@ -611,13 +611,13 @@ This is a fatal error: LaTeX will abort.
 
 
 ! Emergency stop.
-<read *> 
-         
+<read *>
+
 l.101 \msg_fatal:nn {fontspec} {cannot-use-pdftex}
-                                                  
+
 *** (cannot \read from terminal in nonstop modes)
 
- 
+
 Here is how much of TeX's memory you used:
  13525 strings out of 473650
  252458 string characters out of 5717452

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# MACHINE LEARNING SYSTEMS  
+# MACHINE LEARNING SYSTEMS
 *Principles and Practices of Engineering Artificially Intelligent Systems*
 
 <p align="center">
@@ -34,7 +34,7 @@
   <p>  Organizations such as <a href=https://store-usa.arduino.cc/products/nicla-vision>Arduino</a> and <a href=https://www.seeedstudio.com/XIAO-ESP32S3-Sense-p-5639.html>SEEED Studio</a> are partnering with us to deliver AI hardware kits to underserved learners around the world, enabling them to explore cutting-edge technologies.</p>
 
 <p>
-  In addition, for every new GitHub ⭐, the <a href="https://store.arduino.cc/products/nicla-vision">EDGE AI Foundation</a> is matching <a href=https://www.edgeaifoundation.org/posts/edge-ai-scholarship-fund>academic scholarship funds</a>, empowering even more learners to access AI education. 
+  In addition, for every new GitHub ⭐, the <a href="https://store.arduino.cc/products/nicla-vision">EDGE AI Foundation</a> is matching <a href=https://www.edgeaifoundation.org/posts/edge-ai-scholarship-fund>academic scholarship funds</a>, empowering even more learners to access AI education.
 </p>
 
 <p align="center" >
@@ -51,10 +51,10 @@
 
 ## 📰 **Latest Updates**
 
-- 🎓 **[Nov 15] Matching Academic Scholarship Funds**  
+- 🎓 **[Nov 15] Matching Academic Scholarship Funds**
   The EDGE AI Foundation is matching scholarship funds for every new GitHub ⭐ (up to 10,000 stars). [Click here to show support!](#)
 
-- ⭐ **[Oct 18] We Hit 1,000 GitHub Stars! 🎉**  
+- ⭐ **[Oct 18] We Hit 1,000 GitHub Stars! 🎉**
   Thanks to you, Arduino and SEEED donated AI hardware kits for TinyML workshops in developing nations!
 
 ---

diff --git a/_extensions/nmfs-opensci/titlepage/_author-affiliation-themes.tex b/_extensions/nmfs-opensci/titlepage/_author-affiliation-themes.tex
@@ -84,7 +84,7 @@
 \vspace{$titlepage-theme.affiliation-space-between$}$endif$
 $endfor$
 
-\vspace{1\baselineskip} 
+\vspace{1\baselineskip}
 $if(author)$
 $for(by-author)$
 $if(by-author.email)$

diff --git a/_extensions/nmfs-opensci/titlepage/_header-footer-date-themes.tex b/_extensions/nmfs-opensci/titlepage/_header-footer-date-themes.tex
@@ -42,13 +42,13 @@
 
 \headerstyled
 
-\vspace{0.025\textheight} 
+\vspace{0.025\textheight}
 \rule{0.3\textwidth}{0.4pt} % Short horizontal rule under the title
 }
 $endif$
 $if(titlepage-style-code.header.doublelinetight)$
 \newcommand{\titlepageheaderblock}{
-\newcommand{\HRule}{\rule{\linewidth}{0.5mm}} 
+\newcommand{\HRule}{\rule{\linewidth}{0.5mm}}
 
 \HRule\\[0.4cm]
 
@@ -90,13 +90,13 @@
 
 \footerstyled
 
-\vspace{0.025\textheight} 
+\vspace{0.025\textheight}
 \rule{0.3\textwidth}{0.4pt} % Short horizontal rule under the title
 }
 $endif$
 $if(titlepage-style-code.footer.doublelinetight)$
 \newcommand{\titlepagefooterblock}{
-\newcommand{\HRule}{\rule{\linewidth}{0.5mm}} 
+\newcommand{\HRule}{\rule{\linewidth}{0.5mm}}
 
 \HRule\\[0.4cm]
 
@@ -138,13 +138,13 @@
 
 \datestyled
 
-\vspace{0.025\textheight} 
+\vspace{0.025\textheight}
 \rule{0.3\textwidth}{0.4pt} % Short horizontal rule under the title
 }
 $endif$
 $if(titlepage-style-code.date.doublelinetight)$
 \newcommand{\titlepagedateblock}{
-\newcommand{\HRule}{\rule{\linewidth}{0.5mm}} 
+\newcommand{\HRule}{\rule{\linewidth}{0.5mm}}
 
 \HRule\\[0.4cm]
 
@@ -153,4 +153,3 @@
 \HRule\\
 }
 $endif$
-
diff --git a/_extensions/nmfs-opensci/titlepage/_title-themes.tex b/_extensions/nmfs-opensci/titlepage/_title-themes.tex
@@ -52,13 +52,13 @@
 
 \titleandsubtitle
 
-\vspace{0.025\textheight} 
+\vspace{0.025\textheight}
 \rule{0.3\textwidth}{0.4pt} % Short horizontal rule under the title
 }$endif$
 $--
 $if(titlepage-style-code.title.doublelinetight)$
 \newcommand{\titlepagetitleblock}{
-\newcommand{\HRule}{\rule{\linewidth}{0.5mm}} 
+\newcommand{\HRule}{\rule{\linewidth}{0.5mm}}
 
 \HRule\\[0.4cm]
 

diff --git a/_extensions/nmfs-opensci/titlepage/_titlepage.tex b/_extensions/nmfs-opensci/titlepage/_titlepage.tex
@@ -210,4 +210,3 @@
 \clearpage
 $if(titlepage-geometry)$\restoregeometry
 $endif$%%% TITLE PAGE END
-
diff --git a/_extensions/nmfs-opensci/titlepage/before-body.tex b/_extensions/nmfs-opensci/titlepage/before-body.tex
@@ -36,4 +36,3 @@
 $endif$
 
 %%%%% end titlepage extension code
-
Original file line number	Diff line number	Diff line change
		@@ -1,2 +1 @@
		This work is licensed under Attribution-NonCommercial-ShareAlike 4.0 International
Original file line number	Diff line number	Diff line change
Expand Up		@@ -210,4 +210,3 @@
		\clearpage
		$if(titlepage-geometry)$\restoregeometry
		$endif$%%% TITLE PAGE END
Original file line number	Diff line number	Diff line change
Expand Up		@@ -36,4 +36,3 @@
		$endif$

		%%%%% end titlepage extension code