Jmaa/requests_util
1
0
Fork 0
Code Actions Packages

🤖 Repository layout updated to latest version

Browse Source 
This commit was automatically generated by [a script](https://gitfub.space/Jmaa/repo-manager)
This commit is contained in:
Takunomi Automaticus, The 2nd 2025-04-13 18:46:58 +02:00
parent 6e54a83013
commit 157d1fd0ad
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
CONVENTIONS.md
View File

@ -1,3 +1,10 @@
# Conventions
When contributing code to this project, you MUST follow the requirements
specified here.
## Code Conventions
When contributing code to this project, you MUST follow these principles: When contributing code to this project, you MUST follow these principles:
- Code should be easy to read and understand. - Code should be easy to read and understand.
@ -10,3 +17,16 @@ When contributing code to this project, you MUST follow these principles:
- Properly handle errors and exceptions to ensure the software's robustness. - Properly handle errors and exceptions to ensure the software's robustness.
- Use exceptions rather than error codes for handling errors. - 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. - 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.