Contributing
Issues, PRs, and docs are welcome. A Star is fine too.
Start here
- File bugs with the bug notes
- Open an Issue before changing behavior
- Docs live in
docs/(VitePress) - Tests, or fixes for confirmed issues
Local
| Path | |
|---|---|
/ | CLI, core, build_runner builder |
example/ | Small app |
docs/ | Docs |
sh
dart pub get
dart test
dart analyze
cd docs && npm ci && npm run docs:devDon't skip hooks. Don't reformat the whole tree in a feature PR.
Conventions
- CLI and warnings stay in Chinese
- Generated files go through
dart_style - User-visible changes update
CHANGELOG.mdand the matching docs page
PRs
- One thing per PR
- Behavior changes need tests
- Say why, link the Issue
There is also a root CONTRIBUTING.md.