Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (25 loc) · 905 Bytes

CONTRIBUTING.md

File metadata and controls

30 lines (25 loc) · 905 Bytes
Raw

Contributing

This project uses submodules so that actions may be added to the GitHub marketplace. Clone with:

git clone --recurse-submodules https://github.com/wasmCloud/actions.git

Lint

We use GitHub Super-Linter to ensure code quality and consistency. You can run the linter locally using Docker:

# optionally add --platform linux/amd64 if on arm
docker run \
   --platform linux/amd64 \
   -e "FILTER_REGEX_EXCLUDE=dist/**/*" \
   -e VALIDATE_JAVASCRIPT_ES=false \
   -e VALIDATE_JSCPD=false \
   -e VALIDATE_TYPESCRIPT_ES=false \
   -e VALIDATE_BIOME_FORMAT=false \
   -e VALIDATE_BIOME_LINT=false \
   -e FIX_MARKDOWN_PRETTIER=true \
   -e FIX_YAML_PRETTIER=true \
   -e FIX_GITHUB_ACTIONS_ZIZMOR=true \
   -e DEFAULT_BRANCH=main \
   -e RUN_LOCAL=true \
   -v .:/tmp/lint \
   ghcr.io/super-linter/super-linter:slim-latest