Compare commits
No commits in common. "8372ddab9f7b7cf4f7b978deae883debbf5d2b91" and "b28c9d35fbec64f5b2c87ffbe062ebed5bcd7871" have entirely different histories.
8372ddab9f
...
b28c9d35fb
|
@ -3,7 +3,7 @@ on:
|
||||||
push:
|
push:
|
||||||
tags:
|
tags:
|
||||||
- 'v[0-9]+.[0-9]+.[0-9]+'
|
- 'v[0-9]+.[0-9]+.[0-9]+'
|
||||||
paths-ignore: ['README.md', '.gitignore', 'LICENSE', 'CONVENTIONS.md', 'ruff.toml']
|
paths-ignore: ["README.md", ".gitignore", "LICENSE", "ruff.toml"]
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
Package:
|
Package:
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
name: Python Ruff Code Quality
|
name: Python Ruff Code Quality
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
paths-ignore: ['README.md', '.gitignore', 'LICENSE', 'CONVENTIONS.md', 'ruff.toml']
|
paths-ignore: ["README.md", ".gitignore", "LICENSE"]
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
ruff:
|
ruff:
|
||||||
|
|
|
@ -2,7 +2,7 @@ name: Run Python tests (through Pytest)
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
paths-ignore: ['README.md', '.gitignore', 'LICENSE', 'CONVENTIONS.md', 'ruff.toml']
|
paths-ignore: ["README.md", ".gitignore", "LICENSE", "ruff.toml"]
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
Test:
|
Test:
|
||||||
|
|
|
@ -2,7 +2,7 @@ name: Verify Python project can be installed, loaded and have version checked
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
paths-ignore: ['README.md', '.gitignore', 'LICENSE', 'CONVENTIONS.md', 'ruff.toml']
|
paths-ignore: ["README.md", ".gitignore", "LICENSE", "ruff.toml"]
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
Test:
|
Test:
|
||||||
|
|
|
@ -1,12 +0,0 @@
|
||||||
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.
|
|
|
@ -32,10 +32,6 @@ Full list of requirements:
|
||||||
- [requests_cache](https://pypi.org/project/requests_cache/)
|
- [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
|
## License
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
Loading…
Reference in New Issue
Block a user