Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
23 lines (16 loc) · 723 Bytes

CONTRIBUTING.md

File metadata and controls

23 lines (16 loc) · 723 Bytes

Contributing

The README has instructions about how to do testing and lint checking.

Generally you do:

git clone https://github.com/peterbe/minimalcss.git
cd minimalcss
./bin/minimalcss.js https://news.ycombinator.com

If you make a PR, GitHub Actions will run unit tests, lint checks and end-to-end testing. Hopefully it's clear from any errors there what needs to be done.

Style guide

All patches are expected to run Prettier as described and configured in the .prettierrc. You can run this with yarn lintcheck. There are no lint checking pre-commit git hooks.

Variables names should be camelCase and it's someUrl or someCss not someURL or someCSS.