Compare commits
No commits in common. "9ed6925e1eec72f82b80cae53cc54c41fbb201f6" and "f94ff770c791faee31162b1b5a676aecd9d8b286" have entirely different histories.
9ed6925e1e
...
f94ff770c7
|
@ -1,10 +1,3 @@
|
||||||
# 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.
|
||||||
|
@ -17,16 +10,3 @@ 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.
|
|
||||||
|
|
|
@ -1 +1 @@
|
||||||
__version__ = '0.1.12'
|
__version__ = '0.1.11'
|
||||||
|
|
Loading…
Reference in New Issue
Block a user