From 85890206c06ab2e7aac300e96a2af476a86c6127 Mon Sep 17 00:00:00 2001 From: takunomi-build-bot Date: Fri, 14 Mar 2025 00:00:15 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=A4=96=20Repository=20layout=20updated=20?= =?UTF-8?q?to=20latest=20version?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This commit was automatically generated by a script: https://gitfub.space/Jmaa/repo-manager --- .gitea/workflows/python-package.yml | 2 +- .gitea/workflows/python-ruff.yml | 2 +- .gitea/workflows/python-test.yml | 2 +- .gitea/workflows/python-version-check.yml | 2 +- CONVENTIONS.md | 12 ++++++++++++ README.md | 4 ++++ 6 files changed, 20 insertions(+), 4 deletions(-) create mode 100644 CONVENTIONS.md diff --git a/.gitea/workflows/python-package.yml b/.gitea/workflows/python-package.yml index 09275ea..bca3388 100644 --- a/.gitea/workflows/python-package.yml +++ b/.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: diff --git a/.gitea/workflows/python-ruff.yml b/.gitea/workflows/python-ruff.yml index b1be7a3..7d0737a 100644 --- a/.gitea/workflows/python-ruff.yml +++ b/.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: diff --git a/.gitea/workflows/python-test.yml b/.gitea/workflows/python-test.yml index 53d4856..ee720ff 100644 --- a/.gitea/workflows/python-test.yml +++ b/.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: diff --git a/.gitea/workflows/python-version-check.yml b/.gitea/workflows/python-version-check.yml index 8a4cb50..a984a06 100644 --- a/.gitea/workflows/python-version-check.yml +++ b/.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: diff --git a/CONVENTIONS.md b/CONVENTIONS.md new file mode 100644 index 0000000..714e6dd --- /dev/null +++ b/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. diff --git a/README.md b/README.md index 61ba5d7..cf01117 100644 --- a/README.md +++ b/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 ```