The Hackney Design System contains everything you need to build user interfaces for Hackney platforms and services.
We have a Codepen for you to quickly experiment with code samples from the design system, and a prototype kit for making flows to share with stakeholders or use in research.
We have starter kits for using the design system in production.
We use a feature-branching strategy. Make your pull requests to the develop branch. See docs/contributing/git-workflow.md for release and branch-sync policy.
See the full contributor guidance
- Pushes run unit tests and a production dependency audit (see
tests.yml). - Publishing uses npm trusted publishers (OIDC) via
publish-npm.yml— no long-livedNPM_TOKENin the publish workflows. - Maintainers can publish a prerelease to npm
@nextwhen ready (publish-npm.yml, channelnext— requires approval on thenpm-prereleaseenvironment). - Merging a Release Please PR creates a GitHub Release;
publish-npm.ymlthen publishes to npmlatest(via thenpm-releaseenvironment).prepublishOnlyvalidates the npm pack contents only (no docs or dist build). - Use
publish-npm.yml(channellatest) for manuallatestpublishes when the automatic path did not run (also usesnpm-releaseenvironment approval).
The Sass API docs under static/sassdoc are committed to the repo. Regenerate locally only when SCSS changes require it (install sassdoc temporarily, run sassdoc lbh --dest static/sassdoc, then commit).