🤖 Repository layout updated to latest version
This commit was automatically generated by [a script](https://gitfub.space/Jmaa/repo-manager)
This commit is contained in:
parent
c258e78294
commit
2493ba739c
|
@ -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:
|
||||
|
||||
- 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.
|
||||
- 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.
|
||||
|
|
Loading…
Reference in New Issue
Block a user