[pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci
callowayproject · Oct 7, 2024 · a77539c · a77539c
1 parent c676d30
commit a77539c
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 43 deletions.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -17,24 +17,24 @@ 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,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall
-  community
+- 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
 
 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
-  professional setting
+- 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,7 +60,7 @@ 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
-[INSERT CONTACT METHOD].
+\[INSERT CONTACT METHOD\].
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the
@@ -119,14 +119,14 @@ version 2.1, available at
 [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
 
 Community Impact Guidelines were inspired by
-[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+[Mozilla's code of conduct enforcement ladder][mozilla coc].
 
 For answers to common questions about this code of conduct, see the FAQ at
-[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/faq][faq]. Translations are available at
 [https://www.contributor-covenant.org/translations][translations].
 
+[faq]: https://www.contributor-covenant.org/faq
 [homepage]: https://www.contributor-covenant.org
-[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
-[Mozilla CoC]: https://github.com/mozilla/diversity
-[FAQ]: https://www.contributor-covenant.org/faq
+[mozilla coc]: https://github.com/mozilla/diversity
 [translations]: https://www.contributor-covenant.org/translations
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -5,6 +5,7 @@ First off, thanks for taking the time to contribute! ❤️
 All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it much easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
 
 > If you like the project but don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
+>
 > - Star the project
 > - Tweet about it
 > - Refer to this project in your project's readme
@@ -21,14 +22,12 @@ All types of contributions are encouraged and valued. See the [Table of Contents
 - [Styleguides](#styleguides)
 - [Join The Project Team](#join-the-project-team)
 
-
 ## Code of Conduct
 
 This project and everyone participating in it are governed by the
 [Code of Conduct](https://github.com/callowayproject/hiring-software-engineers/blob/master/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior
 to <[email protected]>.
 
-
 ## I Have a Question
 
 > If you want to ask a question, we assume that you have read the available [Documentation](https://callowayproject.github.io/hiring-software-engineers/).
@@ -54,12 +53,11 @@ A good bug report shouldn't leave others needing to chase you up for more inform
 - To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/callowayproject/hiring-software-engineers/issues).
 - Also, make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
 - Collect information about the bug:
-  - Stack trace (Traceback)
-  - OS, Platform, and Version (Windows, Linux, macOS, x86, ARM)
-  - The version of Python
-  - Possibly your input and the output
-  - Can you reliably reproduce the issue? And can you also reproduce it with older versions?
-
+    - Stack trace (Traceback)
+    - OS, Platform, and Version (Windows, Linux, macOS, x86, ARM)
+    - The version of Python
+    - Possibly your input and the output
+    - Can you reliably reproduce the issue? And can you also reproduce it with older versions?
 
 ### How Do I Submit a Good Bug Report?
 
@@ -78,7 +76,6 @@ Once it's filed:
 - A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and will not address them until they are included.
 - If the team is able to reproduce the issue, the issue will be left to be [implemented by someone](#your-first-code-contribution).
 
-
 ## Suggesting Enhancements
 
 This section guides you through submitting an enhancement suggestion for Hiring Software Engineers, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
@@ -104,7 +101,6 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/callow
 
 ## Your First Code Contribution
 
-
 > ### Legal Notice
 >
 > When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
@@ -133,14 +129,14 @@ python -m pip install ".[dev,test,docs]"
 ### Run tests
 
 Once setup, you should be able to run tests:
+
 ```
 pytest
 ```
 
 ## Install Pre-commit Hooks
 
-
-Pre-commit hooks are scripts that run every time you make a commit. If any of the scripts fail, it stops the commit. You can see a listing of the checks in the ``.pre-commit-config.yaml`` file.
+Pre-commit hooks are scripts that run every time you make a commit. If any of the scripts fail, it stops the commit. You can see a listing of the checks in the `.pre-commit-config.yaml` file.
 
 ```
 pre-commit install

diff --git a/docs/glossary.md b/docs/glossary.md
@@ -1,12 +1,12 @@
 ---
-title: Glossary 
-description: A glossary of terminology used in the Hiring Software Engineers package and documentation. 
+title: Glossary
+description: A glossary of terminology used in the Hiring Software Engineers package
+  and documentation.
 date: 2024-07-26
 comments: true
 ---
 
 A glossary of terminology and nomenclature used in the hiring-software-engineers package and documentation.
 
 !!! warning
-
     Glossary not implemented yet! Recommend each item has its own anchor link.
diff --git a/docs/index.md b/docs/index.md
@@ -7,10 +7,10 @@ comments: true
 
 # Hiring Software Engineers
 
-{% 
-    include-markdown 
-    "../README.md" 
-    start="<!--start-->" 
-    end="<!--end-->"
-    rewrite-relative-urls=false
+{%
+include-markdown
+"../README.md"
+start="<!--start-->"
+end="<!--end-->"
+rewrite-relative-urls=false
 %}
diff --git a/docs/introduction.md b/docs/introduction.md
@@ -9,7 +9,7 @@ This page explains why Hiring Software Engineers is the way it is.
 
 !!! warning
 
-   Explanation has not been implemented yet!
+Explanation has not been implemented yet!
 
 Explanation is **discussion** that clarifies and illuminates a particular topic. Explanation is **understanding-oriented.**