Skip to main content

Contribute

Report a bug​

Open an issue with:

  • What you did.
  • What you expected.
  • What happened.
  • The commit or version, browser, and setup method.
  • Steps that let another person reproduce the problem.

Remove tokens, private recipe notes, and household data from logs and images.

Suggest a change​

Explain the task you cannot complete and why it matters. For a large change, open an issue before you start work.

Submit code or docs​

  1. Follow Local setup.
  2. Create a branch with one clear purpose.
  3. Make the change and update the affected docs.
  4. Follow Tests and checks.
  5. Open a pull request. State the problem, the change, and the checks you ran.

For UI changes, include screenshots. For behavior changes, include a regression test when it can catch a real user problem.

Keep docs brief. Use common words, short sentences, and the same name for each concept. Put procedures in guides and exact fields in reference pages.

Add ingredient icons​

Icons are 160 px WebP files in web/src/assets/ingredients/. Drop in a file with a descriptive name, for example olive-oil.webp, and the app matches it by name. Then run pnpm icons:manifest so the server accepts the name. See the README in that folder for the sheet workflow, naming rules, and matcher overrides.