Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 963 Bytes

CONTRIBUTING.md

File metadata and controls

39 lines (26 loc) · 963 Bytes
Raw

Contributing to apidoc

Contributing to the code

Branches

The "master" branch is the stable released version. The "dev" branch is where the development happens.

  • Base your work on the "dev" branch
  • Target the "dev" branch for your PR

Tests

  • Make sure to run the tests with "npm run test"
  • Add new tests if you add new code

Linting

  • Run "npm run eslint" to find linting issues with your changes.

Pre-commit hook

It is useful to use a pre-commit hook to make sure the code you are committing is error-free (as much as possible at least). For that start by renaming the file .git/hooks/pre-commit.sample to .git/hooks/pre-commit, and add this before the last "exec" line:

# test/linting 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

i18n

Language files are located in template/locales.