🤖 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,12 @@
+When contributing code to this project, you MUST follow these principles:
+
+- Code should be easy to read and understand.
+- Keep the code as simple as possible. Avoid unnecessary complexity.
+- Use meaningful names for variables, functions, etc. Names should reveal intent.
+- Functions should be small and do one thing well. They should not exceed a few lines.
+- Function names should describe the action being performed.
+- 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.
+- Properly handle errors and exceptions to ensure the software's robustness.
+- Use exceptions rather than error codes for handling errors.
+- Consider security implications of the code. Implement security best practices to protect against vulnerabilities and attacks.

README.md

@@ -32,6 +32,10 @@ Full list of requirements:
 - [requests_cache](https://pypi.org/project/requests_cache/)
 
 
+## Contributing
+
+Feel free to submit pull requests. Please follow the [Code Conventions](CONVENTIONS.md) when doing so.
+
 ## License
 
 ```