Contributing

Contributions are always welcome, no matter how large or small.

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

Code of Conduct

By participating, you are expected to uphold this Contributor Covenant Code of Conduct. Please report unacceptable behavior to sharvita@gmail.com.

Project setup

First, fork then clone the repo:

git clone https://github.com/your-username/node-mdl-starter
cd node-mdl-starter
git remote add upstream https://github.com/sharvit/node-mdl-starter

Install dependencies:

yarn

Run test suits to validate the project is working:

yarn test
# run test in watch mode
yarn test:watch

Build the project:

yarn build
# only build the dist folder from source
yarn webpack:build
# build webpack with a development mode and watch files
yarn webpack:develop
# only build the docs using esdocs
yarn docs:build
# build docs in watch mode
yarn docs:develop

Run linter to validate the project code:

yarn lint
# to fix linting errors
yarn lint --fix

Run linter to validate your commit message:

yarn lint:commit

Committing and Pushing changes

Create a branch and start hacking:

git checkout -b my-branch

Commit and push your changes:

generator-node-mdl uses commitizen to create commit messages so semantic-release can automatically create releases.

git add .

yarn commit
# answer the questions

git push origin my-branch

Open this project on GitHub, then click “Compare & pull request”.

Help needed

Please checkout the roadmap.md and the open issues.

Also, please watch the repo and respond to questions/bug reports/feature requests, Thanks!