🤖 Repository layout updated to latest version

This commit was automatically generated by a script: https://gitfub.space/Jmaa/repo-manager

.gitea/workflows/python-package.yml

@@ -3,7 +3,7 @@ on:
   push:
     tags:
       - 'v[0-9]+.[0-9]+.[0-9]+'
-    paths-ignore: ["README.md", ".gitignore", "LICENSE", "ruff.toml"]
+    paths-ignore: ['README.md', '.gitignore', 'LICENSE', 'CONVENTIONS.md']
 
 jobs:
   Package:

.gitea/workflows/python-ruff.yml

@@ -1,7 +1,7 @@
 name: Python Ruff Code Quality
 on:
   push:
-    paths-ignore: ["README.md", ".gitignore", "LICENSE"]
+    paths-ignore: ['README.md', '.gitignore', 'LICENSE', 'CONVENTIONS.md']
 
 jobs:
   ruff:

.gitea/workflows/python-test.yml

@@ -2,7 +2,7 @@ name: Run Python tests (through Pytest)
 
 on:
   push:
-    paths-ignore: ["README.md", ".gitignore", "LICENSE", "ruff.toml"]
+    paths-ignore: ['README.md', '.gitignore', 'LICENSE', 'CONVENTIONS.md']
 
 jobs:
   Test:

.gitea/workflows/python-version-check.yml

@@ -2,7 +2,7 @@ name: Verify Python project can be installed, loaded and have version checked
 
 on:
   push:
-    paths-ignore: ["README.md", ".gitignore", "LICENSE", "ruff.toml"]
+    paths-ignore: ['README.md', '.gitignore', 'LICENSE', 'CONVENTIONS.md']
 
 jobs:
   Test:

CONVENTIONS.md

@@ -0,0 +1,8 @@
+When writing code, you MUST follow these principles:
+
+- No trailing whitespace.
+- Use types everywhere possible.
+- Only use comments when necessary, as they can become outdated. Instead, strive to make the code self-explanatory.
+- When comments are used, they should add useful information that is not readily apparent from the code itself.
+- Dictionaries that do not change during the runtime of the program must be
+  placed in top-level scope.

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Jon Michael Aanes
+Copyright (c) 2024-2025 Jon Michael Aanes
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -25,7 +25,9 @@ Defined hierarchy:
 
 ## Dependencies
 
-All requirements can be installed easily using:
+This project requires [Python](https://www.python.org/) 3.8 or newer.
+
+All required libraries can be installed easily using:
 
 ```bash
 pip install -r requirements.txt
@@ -35,12 +37,16 @@ Full list of requirements:
 - [enforce-typing](https://pypi.org/project/enforce-typing/)
 
 
+## Contributing
+
+Feel free to submit pull requests. Please follow the [Code Conventions](CONVENTIONS.md) when doing so.
+
 ## License
 
 ```
 MIT License
 
-Copyright (c) 2024 Jon Michael Aanes
+Copyright (c) 2024-2025 Jon Michael Aanes
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal