Contributing

Thanks for taking an interest in X-Lifestyle Hermes. This is a small, mostly solo-maintained project, so the bar is "explain your reasoning and keep it grounded," not a heavyweight process.

Before you start

• Read the xls umbrella repo's CLAUDE.md — the grounding rule that every claim about X-Change Source behavior must be checked against the actual source, not inferred or assumed, applies here too even though this repo is checked out standalone.
• This mod depends on X-Lifestyle Core (requiredMods in x-lifestyle-hermes.meta) — read Core's docs/INTEGRATION_GUIDE.md and docs/DEVELOPER_GUIDE.md before touching anything that posts to BMFT.StickyNotes or another Core surface.
• Never override a base-game or another mod's function or passage. Only [around] advice, documented extension points (like BMFT.StickyNotes), or calling a shared API as designed are allowed. If no such hook exists for something this mod wants to do, that feature is flagged not-implementable rather than force-overridden.

Setup

npm install
npm test

Making a change

• Coding standards: no separate style guide — follow whatever conventions X-Change Source itself already establishes (Twee passage structure, JS module layout, macro registration idioms), matched to the code adjacent to what you're touching.
• Claims about X-Change Source behavior must come from actually reading the source, not from a file/folder name or a pattern seen in another mod. The unpacked example-mod library is corroborating evidence at best, never authoritative on its own.

Submitting

Open a merge request against main with:

• What changed and why.
• Confirmation npm test passes.
• A CHANGELOG.md entry under [Unreleased].

License

By contributing, you agree your contribution is licensed under this project's Zlib License.