Skip to content

Latest commit

 

History

History
109 lines (80 loc) · 2.05 KB

CONTRIBUTING.md

File metadata and controls

109 lines (80 loc) · 2.05 KB
Raw

Contributing

Getting started

Initialize project at current stage

// acquire source
git clone https://github.com/pouk/idem

cd idem

// install dependencies
npm install

// install lerna globally
npm install -g lerna

// bootstrap w/ internal dependencies
lerna bootstrap

Project structure

High level directory structure

├── CHANGELOG.md
├── client
│   ├── assets
│   │   └── demo.html
│   ├── ava.config.js
│   ├── dist
│   ├── index.js
│   ├── package.json
│   ├── packages
│   │   ├── agent
│   │   │   ├── index.js
│   │   │   ├── package.json
│   │   │   ├── src
│   │   │   └── test
│   │   └── ...
│   ├── src
│   ├── test
│   └── webpack.config.js
├── config
├── common
└── server
    └── packages

Making changes

Branching

Create a topic branch from (usually from master)

Commits

Make commits of logical and atomic units. Make sure to use conventional commit messages, i.e. following fashion:

<type>[optional scope]: <description>

[optional body]

[optional footer]

Type must be one of the following:

  • feat - add new feature
  • fix - fix or enhancement of existing feature
  • test - add missing test or refactor existing
  • refactor - change to production code w/o changing behavior
  • docs - changes to documentation only
  • chore - routine work
  • build
  • ci
  • perf
  • style
  • revert

Optional scope may be:

  • client
  • server
  • config
  • common
  • ...

The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.

Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.

Code Style

Follow JavaScript Standard Style

Tests

Run tests using AVA

npm run test