Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (33 loc) · 1.11 KB

CONTRIBUTING.md

File metadata and controls

50 lines (33 loc) · 1.11 KB
Raw

Contributing

Thanks for your interest in contributing.

Scope

This repository is a public-facing snapshot of a larger private working project. Contributions are welcome for:

  • documentation clarity
  • code quality improvements
  • bug fixes in the public-facing code
  • packaging and developer-experience improvements

Please avoid opening PRs that assume access to removed private assets, local runtime state, or unpublished research data.

Development

Install dependencies:

uv sync --extra dev

Or:

pip install -e ".[dev]"

Run a basic validation pass before submitting changes:

python3 -m py_compile main.py scripts/run_discover.py

If you touch behavior-heavy code, add or update tests where practical.

Pull Requests

  • Keep changes focused.
  • Document user-facing behavior changes in the PR description.
  • Prefer small, reviewable diffs over broad rewrites.
  • Do not commit secrets, credentials, logs, or local state files.

Security

If you notice an issue that could expose credentials or private data, please do not open a public issue with the sensitive details included.