Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 969 Bytes

CONTRIBUTING.md

File metadata and controls

34 lines (25 loc) · 969 Bytes
Raw

How to contribute to malle

Getting started

  1. Fork the repository
  2. Clone it locally
  3. Create a branch from master to work on
  4. Commit your changes
  5. Push your changes
  6. Open a Pull Request

Dev server

First, setup continuous build with npm run watch in a spare terminal/tmux pane, so changes in source code are immediatly visible in produced javascript files.

Then, if your user is in the docker group, start a dev server with npm run dev-server. This will start a webserver and you can then access the demo at http://localhost:4813/demo.

Run npm run stop-dev to stop the dev server and remove the container.

Pre-commit hook

Go into .git/hooks. And cp pre-commit.sample pre-commit. Edit it and before the last line with the “exec”, add this:

# malle pre-commit hook
reset="\e[0m"
red="\e[0;31m"
set -e
if ! npm run pre-commit
then
    printf "${red}error${reset} Pre-commit script found a problem!.\n"
    exit 1
fi