Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (35 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

53 lines (35 loc) · 1.59 KB
Raw

Contributing to muse-shim

Thanks for helping improve this unofficial Meta Muse Code model-provider shim.

Development setup

git clone https://github.com/luckeyfaraday/muse-shim.git
cd muse-shim
python3 -m unittest -v
python3 muse_shim.py --help
python3 muse_shim.py doctor

Optional:

python3 -m pip install -e .

Runtime code uses the Python standard library only. Prefer not adding third-party dependencies unless there is a strong, discussed reason.

What to change

  • Docs / packaging / CI / safety hygiene: welcome as small PRs.
  • Provider transports (muse_providers.py, native OAuth/Messages/Responses paths): keep changes focused; preserve the rule that inference is ordinary HTTP, never codex exec or claude -p.
  • Behavior claims in the README: update them in the same PR when you change capabilities.

Tests

Run the full unit suite before opening a PR:

python3 -m unittest -v

Add or extend tests for new transforms, auth discovery paths, stream conversion, and safety guards. Prefer local fakes over live provider calls in CI.

Pull requests

  • Keep PRs small and reviewable.
  • Describe user-visible behavior and any Muse compatibility impact.
  • Do not commit credentials, local auth files, .env secrets, caches, or absolute home-directory paths.
  • Do not log or print secret values in tests or doctor output.
  • Fill out the pull request template.

Security issues

Do not open a public issue for vulnerabilities. See SECURITY.md.

Code of conduct

Participation is governed by CODE_OF_CONDUCT.md.