Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
28 lines (19 loc) · 764 Bytes

CONTRIBUTING.md

File metadata and controls

28 lines (19 loc) · 764 Bytes
Raw

Contributing

Thanks for considering a contribution. Please follow the guidelines below to keep changes consistent and reviewable.

Quick Steps

  1. Fork the repo and create a branch off main.
  2. Make your change with clear, focused commits.
  3. Run tests or provide a minimal manual test plan in the PR.
  4. Open a pull request with a concise summary and rationale.

Code Style

  • Python: follow PEP 8 and use type hints.
  • Keep functions small and focused.
  • Prefer explicit names over terse abbreviations.

Issue Reporting

If you are reporting a bug, include:

  • Steps to reproduce
  • Expected vs actual behavior
  • Environment details (OS, Python version)

Security Issues

Do not file public issues for security vulnerabilities. See SECURITY.md.