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/generator-node-mdl
cd generator-node-mdl
git remote add upstream https://github.com/sharvit/generator-node-mdl

Install dependencies:

yarn

Run test suits to validate the project is working:

yarn test

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

Creating Pull Requests

1. Create a branch:

git checkout -b my-branch

2. Happy Hacking 🎉: Start hacking and creating code changes.

3. Commit 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

4. Push your changes:

git push origin my-branch

5. 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!