SKILL.md
Dev workflow – Contentstack Dart SDK
When to use
- Starting work in this repository or onboarding
- Before opening a PR (verify analyze, tests, format)
- After editing JSON-serializable models or
partfiles
Instructions
Dependencies and codegen
- Install deps:
dart pub get - If you change files that use
json_serializable/part '*.g.dart', run:
dart run buildrunner build --delete-conflicting-outputs Generated files are excluded from manual lint in analysisoptions.yaml
Quality gates
- Static analysis:
dart analyze(rules inanalysis_options.yaml) - Tests:
dart test - Optional format check:
dart format .
Branches and automation
- Pull requests run [.github/workflows/check-branch.yml](../../.github/workflows/check-branch.yml) (e.g. restrictions when targeting
master) - Publishing: [.github/workflows/publish.yml](../../.github/workflows/publish.yml) on semver tags; dry-run uses
dart pub publish --dry-run
Package docs
- HTML API docs:
dartdocis listed inpubspec.yaml; generate when documenting public API changes
References
- [../contentstack-dart-sdk/SKILL.md](../contentstack-dart-sdk/SKILL.md) — API surface
- [../testing/SKILL.md](../testing/SKILL.md) — tests and coverage
- [../dart-style/SKILL.md](../dart-style/SKILL.md) — layout and analyzer
- Dart SDK environment