Contributing
Help build Helpwren: report a problem, improve these docs, or send a change.
Helpwren is MIT licensed and developed in the open on GitHub. By taking part you agree to follow the code of conduct. Report security problems privately, as the security policy describes.
Ways to help
- Report a bug or ask for a feature in the issues. Say what you ran, what you expected and what happened.
- Improve the docs. Every page here is a Markdown file in the repository's
docs/folder; Edit on GitHub at the foot of each page opens it. - Send a change. Start with Development setup, follow the conventions, and read CONTRIBUTING.md for branches, commits and changesets.
Before you open a pull request
pnpm checkThis runs the format check, lint, typecheck, tests and build, which is what CI runs.
How the code is organised
- Architecture: the monorepo, the app, the database and the widget.
- Decision records: why things are the way they are.
- Design system: tokens, components and illustrations.
- Timing a fresh install: the install times to check before a release.