Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
29 lines (22 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

29 lines (22 loc) · 1.03 KB
Raw

Contributing

Contributions are welcome, especially compatibility reports for newer FreeShow versions, isolated fixtures, accessibility improvements, and additional tests.

Before opening a pull request

  1. Open an issue for behavior that changes native FreeShow data or broadens filesystem/network access.
  2. Do not include real production shows, Bible databases, media, credentials, logs, or backups in fixtures.
  3. Preserve unknown FreeShow fields and the mutation invariants documented in docs/architecture.md.
  4. Keep the runtime compatible with Python 3.9 unless a version change is discussed first.
  5. Run the complete test suite:
PYTHONPATH=src python3 -m unittest discover -s tests -v

Pull requests

Describe the FreeShow version used for testing, the native formats affected, the rollback behavior, and any manual verification performed. Changes that write FreeShow data should include conflict, backup, verification, and failure tests.

By participating, you agree to interact respectfully and constructively.