Contributing

Contributing

Pull requests

Fork xyluz/yanju-scenarios and open a PR against main.

When you add a scene, keep it to one scene per PR.

Spoiler policy

Do not reveal the intended fix in:

• brief.problem / brief.outcome
• index.yaml summaries
• folder README.md files
• wiki pages

Players should be able to read the problem without being told the cause.

What not to commit

• .pytest_cache and other local test leftovers
• Secrets, production credentials, or real TLS keys that are not lab fixtures shipped with the scene

Test locally

export YANJU_SCENES_DIR=/path/to/your/yanju-scenarios
yanju init <id>
yanju play

You can also point at this repo from a Yanjú source checkout; a local yanju-scenarios/ tree next to the CLI is used automatically.

Where to file what

• Scene bugs, new incidents, catalog copy → this repo
• CLI / harness bugs → the Yanjú CLI repository (once it is public)