Skip to content

Latest commit

 

History

History
22 lines (16 loc) · 947 Bytes

CONTRIBUTING.md

File metadata and controls

22 lines (16 loc) · 947 Bytes
Raw

Contributors

Checkin

  • Do checkin source (src)
  • Do not checkin build output (dist)
  • Do not checkin node_modules

Development

In order to handle code style and static analysis, we run Husky before each commit. This step ensures that formatting and checkin rules are followed. To make sure Husky runs correctly, please use the following workflow:

npm install                                 # installs all devDependencies including Husky
git add abc.ext                             # Add the files you've changed. This should include files in src, lib, and node_modules (see above)
git commit -m "Informative commit message"  # Commit. This will run Husky

During the commit step, Husky will take care of formatting all files with Prettier. It will also make sure these changes are appropriately included in your commit (no further work is needed)