Contributing to Fablewright #
Fablewright is a small project. A clear bug report is as useful as a patch. Read this page before you open an issue or a pull request.
Before you start #
- Read the development guide for setup, the code map, the test layout, the schema workflow and the release checklist.
- Read the landmines file for the feature you are about to touch. It holds the traps that a reading of the code does not show.
- Read
AGENTS.mdif you work with an agent. It holds the toolchain, database, auth, access and test rules for this repository. - Read
PRODUCT.mdfor the product scope and the commitments. The most important one is that Fablewright contains no generative AI, and it never will.
Report a bug #
Open an issue at https://tangled.org/katsuricata.com/Fablewright. Include:
- The version and the commit from the admin page or
/api/health. - The deployment: Docker Compose, bare Node, or Cloudron.
- The browser and the operating system.
- The steps that led to the problem, what you expected, and what happened.
- The log lines around the failure.
- A screenshot or a short recording when the problem is visual.
Do not include a manuscript, a password, a secret link, the signing secret, or any other person's data. Use the example project or a new project with made-up words.
For a security problem, do not open a public issue. Follow the security policy.
Send a patch #
- Keep the change small and focused. A patch that fixes one thing is easier to review than a patch that also reformats a file.
- Add or update a test. A bug fix needs a test that fails before the fix.
- Run
pnpm check,pnpm lint,pnpm test:unitandpnpm test:e2ebefore you send it. There is no CI in this repository, so the local run is the gate. - Update the docs when the change affects a writer or an operator. The writer's
guide is
docs/using-fablewright.md, and the operator's guide isdocs/operations.md. - Add a line under
UnreleasedinCHANGELOG.mdwhen a writer or an operator can feel the change. - Keep the project voice: plain English, active voice, no em dashes, no generative-AI features, and comments that explain why rather than what.
- Do not add a dependency without a reason. The project keeps the dependency list small on purpose.
A pull request that changes the schema needs a migration generated with
pnpm db:generate, the SQL committed under drizzle/, and a note in the
changelog. Do not edit an applied migration, and do not use drizzle-kit push.
Licence #
Fablewright is licensed under the Mutualist License v1.3, Short ID MutuaL-1.3.
See LICENSE.md for the terms.