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:
- Fork it!
- Create your feature branch:
git checkout -b feature/awesome-feature - Run:
npm installfor dependencies andnpm linkfor local development - Commit your changes:
git commit -m 'feat(Project): Adds awesome feature' - Push to the branch:
git push origin feature/awesome-feature - Submit a pull request 👍
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