Contributors¶
This project exists thanks to its contributors.
Contributors¶
- Gregory Beam (@KI7MT) — Project lead, architecture, packaging, documentation
Contribution Checklist¶
When contributing new code, documentation, or other resources, please ensure:
- Coding Standards
- Add docstrings for all functions, classes, and modules.
- Run
make testand ensure all unit tests pass. -
Run
pre-commit run --all-filesbefore committing. -
Documentation Standards
- Use lowercase filenames in
docs/(e.g.,troubleshooting.md). - Update
mkdocs.ymlto include new docs under the correctnavsection. - Verify that all internal links in Markdown files resolve correctly.
-
Copy root-level files (
CHANGELOG.md,LICENSE.md) intodocs/if you want them visible on GitHub Pages. -
Releases
- Update
CHANGELOG.mdwith changes. - Bump
__version__insrc/wspr_ai_lite/__init__.py. - Tag the release (
git tag vX.Y.Z && git push --tags). -
Smoke test with
make smoke-testormake smoke-test-pypi. -
General
- Keep commits atomic and meaningful.
- Prefer PRs from feature branches.
- Be respectful and collaborative.
Thank you for helping improve WSPR AI Lite 🚀