Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 1.41 KB

Dev-Setup.md

File metadata and controls

46 lines (30 loc) · 1.41 KB

Dev Setup

Pre-Push Hook

We created a pre-push hook which prevents pushing things to the remote repository that should not be there.

For this, please copy ./pre-push to .git/hooks/

Check 1: package.json

The pre-push hook runs ./check-package.json.sh which analyzes package.json for non-version-pinned dependencies:

checking package.json...
non version-pinned content found in package.json, ABORT! Please remove all ^ and ~ in package.json to proceed.

Check 2: KILLME content

We introduce the word KILLME alongside TODO, HACK etc.

Whenever you create code that must only be run temporary on your machine, e.g.:

  • code that skips a multi-step wizard or
  • hardcodes a certain state or
  • prints debug infos

accompany this code with a comment stating KILLME, e.g.:

const initialStep = 2; // KILLME: initialStep = 0;
<p>DEBUG: {{ myVar }}</p>
<!-- KILLME -->

The pre-push hook will prevent pushing if KILLME content is found in ./src:

checking for KILLME content...
KILLME content found in ./src, ABORT! Please remove all KILLME content from ./src to proceed.

We recommend the VS Code extension TODO Tree. Go to Settings and add KILLME to the tags. You may also remove [x] from the tags.