1
0

🤖 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:
Takunomi Automaticus, The 2nd 2025-03-14 00:00:16 +01:00
parent 8d1232d48d
commit 6ffe63c11c
6 changed files with 24 additions and 6 deletions

View File

@ -3,7 +3,7 @@ on:
push:
tags:
- 'v[0-9]+.[0-9]+.[0-9]+'
paths-ignore: ["README.md", ".gitignore", "LICENSE", "ruff.toml"]
paths-ignore: ['README.md', '.gitignore', 'LICENSE', 'CONVENTIONS.md']
jobs:
Package:

View File

@ -2,7 +2,7 @@ name: Run Python tests (through Pytest)
on:
push:
paths-ignore: ["README.md", ".gitignore", "LICENSE", "ruff.toml"]
paths-ignore: ['README.md', '.gitignore', 'LICENSE', 'CONVENTIONS.md']
jobs:
Test:

View File

@ -2,7 +2,7 @@ name: Verify Python project can be installed, loaded and have version checked
on:
push:
paths-ignore: ["README.md", ".gitignore", "LICENSE", "ruff.toml"]
paths-ignore: ['README.md', '.gitignore', 'LICENSE', 'CONVENTIONS.md']
jobs:
Test:

12
CONVENTIONS.md Normal file
View File

@ -0,0 +1,12 @@
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.

View File

@ -1,6 +1,6 @@
MIT License
Copyright (c) 2024 Jon Michael Aanes
Copyright (c) 2024-2025 Jon Michael Aanes
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

View File

@ -73,7 +73,9 @@ python -m libpurple_to_markdown LOG_DIRECTORY --output OUTPUT_FOLDER --skip-this
## Dependencies
All requirements can be installed easily using:
This project requires [Python](https://www.python.org/) 3.8 or newer.
All required libraries can be installed easily using:
```bash
pip install -r requirements.txt
@ -83,12 +85,16 @@ Full list of requirements:
- [beautifulsoup4](https://pypi.org/project/beautifulsoup4/)
## Contributing
Feel free to submit pull requests. Please follow the [Code Conventions](CONVENTIONS.md) when doing so.
## License
```
MIT License
Copyright (c) 2024 Jon Michael Aanes
Copyright (c) 2024-2025 Jon Michael Aanes
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal