generator-furzeface

Yeoman generator for a basic project

Usage

• First, install NodeJS
• Then install Yeoman (globally): npm i -g yo
• Then install the generator (globally): npm i -g generator-furzeface
• Create a directory for your project and enter it: mkdir my-awesome-project && cd $_
• To initialise a project run: yo furzeface

Contributing

To contribute either check the Waffle board or GitHub issues then work away:

1. Fork it!
2. Create your feature branch: git checkout -b feature/awesome-feature
3. Run: npm install for dependencies and npm link for local development
4. Commit your changes: git commit -m 'feat(Project): Adds awesome feature'
5. Push to the branch: git push origin feature/awesome-feature
6. Submit a pull request :+1:

Tips:

• In lieu of a formal styleguide, take care to maintain the existing coding style.
• Add unit tests for any new or changed functionality.
• Test your code using Mocha: mocha test
• Install editorconfig-sublime for Sublime Text to help with consistent code formatting.
• Commit messages loosely adhere to these guidelines.
• Versioning adheres to Semver.

Release History

• Nothing yet

License

MIT: http://danielfurze.mit-license.org