Skip to content

Contributing

When contributing do open an issue at the repository or start a GitHub discussion first.

You can create your own fork before making a pull request.

Before doing this, do open an issue at this repository first.

This repository comes with some scripts. The important ones include:

  • npm run dev: SCSS to CSS compiler, assumes you have Sass (Dart, Node) installed
  • npm run lint: Lints the entire SCSS codebase. Reruns linting when a file write is detected in source files
  • npm run lint-once: As its namesake says, lints the codebase once
  • npm run fix: Equivalent to running stylelint --fix. Run this only after your file changes are saved.

If you prefer to use CSS instead of SCSS, place your proposed code changes or snippets in the css/ folder. The maintainer will try to integrate them.

Do note that this repository has its own Code of Conduct and Contributing Guide.