Assemble Inc. Frontend Code Standards
This repository contains resources for ensuring consistency and quality across different Assemble projects.
Assemble has developed a custom ESLint configuration file that should be used on all greenfield Assemble Projects. This package extends ESLint recommended settings with some specific modifications selected by the Assemble dev team. You can read more here.
The Assemble prettier configuration and editor configuration files are used to maintain consistent coding style across Assemble projects. This package extends the recommended settings with some minor adjustments for team preferences. You can read more here.
The Assemble Tailwind configuration files is used to maintain consistent coding style across Assemble tailwind projects. This package extends the recommended settings with some minor adjustments for team preferences.
The Assemble TypeScript configuration file is used to maintain consistent typescript standards across Assemble projects. This package extends the recommended settings with some minor adjustments for team preferences.
- Clone this repo
- Create a branch:
git checkout -b developer-name/component-name
- Make some changes
- Test your changes
- Push your branch and open a Pull Request
- Request a reviewer, or let the team know
Then every time you make an update to the library, republish it to npm:
- Run
yarn publish-packages
- At root of repo run
yarn changeset
and follow instructions - this will automatically bump major/minor versions of packages and prepare them to be published. Any packages with"private": true
in theirpackage.json
will not be published. - Run
yarn changeset publish