Skip to content

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:

  1. Coding Standards
  2. Add docstrings for all functions, classes, and modules.
  3. Run make test and ensure all unit tests pass.
  4. Run pre-commit run --all-files before committing.

  5. Documentation Standards

  6. Use lowercase filenames in docs/ (e.g., troubleshooting.md).
  7. Update mkdocs.yml to include new docs under the correct nav section.
  8. Verify that all internal links in Markdown files resolve correctly.
  9. Copy root-level files (CHANGELOG.md, LICENSE.md) into docs/ if you want them visible on GitHub Pages.

  10. Releases

  11. Update CHANGELOG.md with changes.
  12. Bump __version__ in src/wspr_ai_lite/__init__.py.
  13. Tag the release (git tag vX.Y.Z && git push --tags).
  14. Smoke test with make smoke-test or make smoke-test-pypi.

  15. General

  16. Keep commits atomic and meaningful.
  17. Prefer PRs from feature branches.
  18. Be respectful and collaborative.

Thank you for helping improve WSPR AI Lite 🚀