1
0

Compare commits

...

2 Commits

Author SHA1 Message Date
b05f889144 🤖 Bumped version to 0.1.50
All checks were successful
Package Python / Package (push) Successful in 25s
Python Ruff Code Quality / ruff (push) Successful in 22s
Run Python tests (through Pytest) / Test (push) Successful in 24s
Verify Python project can be installed, loaded and have version checked / Test (push) Successful in 21s
This commit was automatically generated by [a script](https://gitfub.space/Jmaa/repo-manager)
2025-04-13 18:47:05 +02:00
14858c416b 🤖 Repository layout updated to latest version
This commit was automatically generated by [a script](https://gitfub.space/Jmaa/repo-manager)
2025-04-13 18:46:58 +02:00
2 changed files with 30 additions and 6 deletions

View File

@ -1,8 +1,32 @@
When writing code, you MUST follow these principles: # Conventions
- No trailing whitespace. When contributing code to this project, you MUST follow the requirements
- Use types everywhere possible. specified here.
## Code Conventions
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. - 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. - 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 - Properly handle errors and exceptions to ensure the software's robustness.
placed in top-level scope. - 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.
- Documentation should document semantics, not syntax.
- Prefer importing modules, not individual items from modules.
- Do not use f-strings in logging statements.
- Loop variables and walrus-expression-variables should be deleted when
unneeded to keep scope clean, and to avoid accidental use.
## Testing
When contributing test to this project, you MUST follow these principles:
- Do not use any testing libraries other than `pytest`.
- Mocking is the root of all evil. Writing your own stubs is much more
preferable.

View File

@ -1 +1 @@
__version__ = '0.1.49' __version__ = '0.1.50'