apply pre-commit hooks

Author: xmnlab

.github/workflows/main.yaml

@@ -1,11 +1,10 @@
-
 name: main
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
+    branches: [main]
 
 jobs:
   check-branch:
@@ -36,36 +35,36 @@ jobs:
       run:
         shell: bash -l {0}
     steps:
-    - uses: actions/checkout@v3
+      - uses: actions/checkout@v3
 
-    - uses: conda-incubator/setup-miniconda@v3
-      with:
-        miniconda-version: "latest"
-        environment-file: conda/dev.yaml
-        channels: conda-forge,nodefaults
-        activate-environment: osl-web
-        auto-update-conda: true
-        conda-solver: libmamba
+      - uses: conda-incubator/setup-miniconda@v3
+        with:
+          miniconda-version: "latest"
+          environment-file: conda/dev.yaml
+          channels: conda-forge,nodefaults
+          activate-environment: osl-web
+          auto-update-conda: true
+          conda-solver: libmamba
 
-    - name: Install dependencies
-      run: |
-        poetry check
-        poetry install
+      - name: Install dependencies
+        run: |
+          poetry check
+          poetry install
 
-    - name: Linter
-      run: |
-        pre-commit install
-        pre-commit run --all-file
+      - name: Linter
+        run: |
+          pre-commit install
+          pre-commit run --all-file
 
-    - name: Build the book
-      run: |
-        makim pages.build
-        echo "opensciencelabs.org" > build/CNAME
+      - name: Build the book
+        run: |
+          makim pages.build
+          echo "opensciencelabs.org" > build/CNAME
 
-    # Push the book's HTML to github-pages
-    - name: GitHub Pages action
-      uses: peaceiris/[email protected]
-      if: ${{ github.event_name == 'push' }}
-      with:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: ./build
+      # Push the book's HTML to github-pages
+      - name: GitHub Pages action
+        uses: peaceiris/[email protected]
+        if: ${{ github.event_name == 'push' }}
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./build

.pre-commit-config.yaml

@@ -5,16 +5,20 @@ repos:
     rev: v4.6.0
     hooks:
       - id: trailing-whitespace
+        exclude: "pages/blog"
       - id: end-of-file-fixer
+        exclude: "pages/blog"
       - id: check-json
       - id: check-toml
       - id: check-xml
       - id: check-builtin-literals
       - id: check-case-conflict
       - id: check-docstring-first
       - id: detect-private-key
+        exclude: "theme"
 
   - repo: https://github.com/pre-commit/mirrors-prettier
     rev: "v3.0.2"
     hooks:
       - id: prettier
+        exclude: "pages/blog|theme"

.prettierignore

@@ -0,0 +1 @@
+docs/changelog.md

.prettierrc.yaml

@@ -0,0 +1,6 @@
+overrides:
+  - files: "*.md"
+    options:
+      parser: remark
+      proseWrap: always
+      printWidth: 80

CODE_OF_CONDUCT.md

@@ -6,8 +6,8 @@ We as members, contributors, and leaders pledge to make participation in our
 community a harassment-free experience for everyone, regardless of age, body
 size, visible or invisible disability, ethnicity, sex characteristics, gender
 identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, religion, or sexual identity
-and orientation.
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
 
 We pledge to act and interact in ways that contribute to an open, welcoming,
 diverse, inclusive, and healthy community.
@@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
 Examples of behavior that contributes to a positive environment for our
 community include:
 
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
   and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
-  overall community
+- Focusing on what is best not just for us as individuals, but for the overall
+  community
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Enforcement Responsibilities
@@ -60,8 +60,8 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-[email protected].
-All complaints will be reviewed and investigated promptly and fairly.
+[email protected]. All complaints will be reviewed and investigated
+promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the
 reporter of any incident.
@@ -82,15 +82,15 @@ behavior was inappropriate. A public apology may be requested.
 
 ### 2. Warning
 
-**Community Impact**: A violation through a single incident or series
-of actions.
+**Community Impact**: A violation through a single incident or series of
+actions.
 
 **Consequence**: A warning with consequences for continued behavior. No
 interaction with the people involved, including unsolicited interaction with
 those enforcing the Code of Conduct, for a specified period of time. This
 includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or
-permanent ban.
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
 
 ### 3. Temporary Ban
 
@@ -106,20 +106,20 @@ Violating these terms may lead to a permanent ban.
 ### 4. Permanent Ban
 
 **Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
+standards, including sustained inappropriate behavior, harassment of an
 individual, or aggression toward or disparagement of classes of individuals.
 
-**Consequence**: A permanent ban from any sort of public interaction within
-the community.
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
 
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage],
 version 2.0, available at
 https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
 
-Community Impact Guidelines were inspired by [Mozilla's code of conduct
-enforcement ladder](https://github.com/mozilla/diversity).
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
 
 [homepage]: https://www.contributor-covenant.org
 

mkdocs.yml

@@ -6,7 +6,7 @@ site_dir: build
 
 theme:
   name: null
-  custom_dir: 'theme/'
+  custom_dir: "theme/"
   features:
     - content.code.copy
   palette:
@@ -23,63 +23,63 @@ extra_javascript:
 
 nav:
   # - Home: 'index.md'
-  - Blog: 'blog/index.md'
+  - Blog: "blog/index.md"
   - Affiliations:
-    - index: affiliations/index.md
+      - index: affiliations/index.md
     # - Member Affiliation: 'affiliations/membership/index.md'
     # - OpenHub: 'affiliations/open-hub/index.md'
   # - Programs:
-    # Mentors: 'projects/mentoring/mentors.md'
-    # - Activities: about/archives/index.md
-    # note> faq is out-of-date
-    # - FAQ: faq/index.md
+  # Mentors: 'projects/mentoring/mentors.md'
+  # - Activities: about/archives/index.md
+  # note> faq is out-of-date
+  # - FAQ: faq/index.md
   - Projects:
-    - index: 'projects/index.md'
-    - Incubator: 'projects/incubator/index.md'
-    - Affiliated:
-      - index: 'projects/affiliated/index.md'
-      - Affiliated Projects: 'projects/affiliated/projects.md'
+      - index: "projects/index.md"
+      - Incubator: "projects/incubator/index.md"
+      - Affiliated:
+          - index: "projects/affiliated/index.md"
+          - Affiliated Projects: "projects/affiliated/projects.md"
     # - Mentoring: 'projects/mentoring/index.md'
     # note: let's keep these projects hidden for now
     # - Packaging Support: 'projects/packaging-support/index.md'
     # - Virtual-Labs: 'projects/virtual-labs/index.md'
   - Careers:
-    - index: careers/index.md
-    - Internship:
-      - index: 'careers/internship/index.md'
-      - Interns Guide: 'careers/internship/guides/interns/index.md'
-      - Mentors Guide: 'careers/internship/guides/mentors/index.md'
-      # - "Cycle 2024-02": 'careers/internship/cycles/2024-02.md'
-      # - "Cycle 2024-01 (CLOSED)": 'careers/internship/cycles/2024-01.md'
-      # - "Cycle 2023-01 (CLOSED)": 'careers/internship/cycles/2023-01.md'
-      - "TEMPLATE: Projects Ideas": 'careers/internship/templates/projects-ideas.md'
-      - "TEMPLATE: Intern Project Proposal": 'careers/internship/templates/intern-proposal.md'
-    - GSoC:
-      - index: 'careers/gsoc/index.md'
-      - Contributor Guide: 'careers/gsoc/guides/contributor/index.md'
-      - "TEMPLATE: Contributor Project Proposal": 'careers/gsoc/templates/contributor-proposal.md'
+      - index: careers/index.md
+      - Internship:
+          - index: "careers/internship/index.md"
+          - Interns Guide: "careers/internship/guides/interns/index.md"
+          - Mentors Guide: "careers/internship/guides/mentors/index.md"
+          # - "Cycle 2024-02": 'careers/internship/cycles/2024-02.md'
+          # - "Cycle 2024-01 (CLOSED)": 'careers/internship/cycles/2024-01.md'
+          # - "Cycle 2023-01 (CLOSED)": 'careers/internship/cycles/2023-01.md'
+          - "TEMPLATE: Projects Ideas": "careers/internship/templates/projects-ideas.md"
+          - "TEMPLATE: Intern Project Proposal": "careers/internship/templates/intern-proposal.md"
+      - GSoC:
+          - index: "careers/gsoc/index.md"
+          - Contributor Guide: "careers/gsoc/guides/contributor/index.md"
+          - "TEMPLATE: Contributor Project Proposal": "careers/gsoc/templates/contributor-proposal.md"
   - Partnership:
-      - index: 'partnership/index.md'
-      - Partners: 'partnership/partners/index.md'
+      - index: "partnership/index.md"
+      - Partners: "partnership/partners/index.md"
   - Events:
-    - index: events/index.md
-    - "OpenVerse'24": events/openverse24/index.md
+      - index: events/index.md
+      - "OpenVerse'24": events/openverse24/index.md
   - Guidelines:
-    - index: guidelines/index.md
-    - Articles: guidelines/articles/index.md
-    - DEI: guidelines/dei/index.md
-    # - DevOps/Discord: guidelines/devops/discord.md
-    # - Fund Raiser: guidelines/fund-raiser/index.md
-    - Mentoring: guidelines/mentoring/index.md
+      - index: guidelines/index.md
+      - Articles: guidelines/articles/index.md
+      - DEI: guidelines/dei/index.md
+      # - DevOps/Discord: guidelines/devops/discord.md
+      # - Fund Raiser: guidelines/fund-raiser/index.md
+      - Mentoring: guidelines/mentoring/index.md
   - About:
-    - index: 'about/index.md'
-    - About OSL: 'about/index.md'
-    - Our Formula: 'about/formula/index.md'
-    - Team: about/team/index.md
-    - Roadmap: about/roadmap/index.md
-    - Governance: about/governance/index.md
-    - CoC: about/coc/index.md
-  - Donate: 'donate/index.md'
+      - index: "about/index.md"
+      - About OSL: "about/index.md"
+      - Our Formula: "about/formula/index.md"
+      - Team: about/team/index.md
+      - Roadmap: about/roadmap/index.md
+      - Governance: about/governance/index.md
+      - CoC: about/coc/index.md
+  - Donate: "donate/index.md"
 
 markdown_extensions:
   - toc:
@@ -101,7 +101,7 @@ plugins:
         tags: {}
 
   - rss:
-      abstract_chars_count: 160  # -1 for full content
+      abstract_chars_count: 160 # -1 for full content
       abstract_delimiter: <!-- more -->
       categories:
         - tags

pages/about/index.md

@@ -46,8 +46,8 @@ We need help in areas, such as:
 - Mentoring
 - Project Managements
 
-Join our community on [discord](/discord). Learn more
-and contribute on [GitHub](https://github.com/opensciencelabs).
+Join our community on [discord](/discord). Learn more and contribute on
+[GitHub](https://github.com/opensciencelabs).
 
 ## Roadmap