Skip to content

Latest commit

 

History

History
34 lines (23 loc) · 1.86 KB

README.md

File metadata and controls

34 lines (23 loc) · 1.86 KB
Raw

ASMBL Frontend Code Standards

This repository contains resources for ensuring consistency and quality across different ASMBL projects.

ESLint Configuration

ASMBL has developed a custom ESLint configuration file that should be used on all greenfield ASMBL Projects. This package extends ESLint recommended settings with some specific modifications selected by the ASMBL dev team. You can read more here.

Prettier Configuration

The ASMBL prettier configuration and editor configuration files are used to maintain consistent coding style across ASMBL projects. This package extends the recommended settings with some minor adjustments for team preferences. You can read more here.

Tailwind Configuration

The ASMBL Tailwind configuration files is used to maintain consistent coding style across ASMBL tailwind projects. This package extends the recommended settings with some minor adjustments for team preferences.

TSConfig

The ASMBL TypeScript configuration file is used to maintain consistent typescript standards across ASMBL projects. This package extends the recommended settings with some minor adjustments for team preferences.

Contributing

  1. Clone this repo
  2. Create a branch: git checkout -b developer-name/component-name
  3. Make some changes
  4. Test your changes
  5. Push your branch and open a Pull Request
  6. Request a reviewer, or let the team know

Publishing

Then every time you make an update to the library, republish it to npm:

  1. Run yarn publish-packages
  2. 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 their package.json will not be published.
  3. Run yarn changeset publish