Contributing

Report a problemCopy Anchor Link

Open an issue on GitHub, and attach the Diagnostics file from Settings → Logs. It contains the recent log lines and your settings with all secrets blanked out, which makes problems much quicker to track down. See Logs.

Pull requests to EpilykosCopy Anchor Link

• Name your branch after the change: fix/…, feat/… or chore/….
• Keep the description short: what changed in a line or two, the bug if it fixes one, the files you edited or added, and why, if it isn't obvious.
• Leave out any tool or assistant attribution: no co-author or session lines in commit messages, and no "generated with" footers or links in the pull request.
• Run npm test before you open it; see the Development guide.
• If the change affects what people see or do, update the matching page of this wiki too.

Improve this wikiCopy Anchor Link

The wiki lives in ashipaek0/epilykos-wiki and is built with Fumapress. Each page is an MDX file under content/docs/, the sidebar order comes from the meta.json files next to them, and images go in public/images/.

npm install
npm run dev        # http://localhost:1337
npm run build      # stops with an error if an internal link is broken

The Supported hardware page is generated from an Epilykos checkout, so after profiles change, regenerate it with:

npm run gen:hardware -- ../Epilykos