

Contribution Guidelines

There are not many contribution guidelines yet. If, however, you are not currently familiar with Yeoman generator development you will find some helpful links.

Basic technologies to know

• Write your own Yeoman generator - This article provides you with basic insights on how to write a custom Yeoman generator

• Mocha getting started - To test that the Yeoman generator is working properly a testing framework named Mocha is used

• Embedded JavaScript templating - EJS is the core engine used in Yeoman to deploy template files and dynamically embed custom settings in the files getting deployed

Places to look for help

The JavaScript a Yeoman generator uses is based on Node.js and many things are treated differently than in the JavaScript that exists in browsers.

• Yeoman API Documentation - Besides the getting started guide, there is official documentation available that covers the complete Yeoman API

• Node.js documentation - In general, a Yeoman generator is written in JavaScript but it is based on Node.js where the development patterns are slightly different. In some cases it might be handy to consult the Node.js documentation.