Thank you for your interest in contributing to the Office of Head Start TTA Smart Hub.
- Set up your local environment by following the Dev Setup Guide.
- Review the Tech Stack for current technology versions.
- See Yarn Commands for a quick reference of available commands.
- Review the Engineering Process for expected workflow, approvals, and release controls.
We prefer TypeScript for new backend files and follow existing patterns in the surrounding code. All changes must pass lint checks (yarn lint:all).
For the full guide — including frontend CSS conventions, Sequelize patterns, error handling, and WYSIWYG editor notes — see Best Practices.
- Add or update tests for any behavior changes.
- Prefer focused unit/integration tests; add E2E only when user-facing flow changes.
- Avoid network calls in unit tests; mock external services.
- All tests run against the same database instance — always create and destroy test data within your tests.
For detailed patterns including database state management helpers, see Testing Guide.
- Create a feature branch from
main. - Make your changes, ensuring tests pass and lint is clean.
- Open a PR using the PR template — it includes checklists for review, accessibility, and deploy steps.
- PRs require review before merging. Tag the team in the
acf-head-start-engSlack channel if you need a reviewer.
Reach out in the acf-head-start-eng Slack channel or open a GitHub issue.