generator-bxd-oss

A generator for my open source projects

Installing / Getting Started

Pre-requisites

This generator assumes you're using Yarn, please install it first.

Install yeoman:

yarn global add yo

Then install this generator:

yarn global generator-bxd-oss

Add semantic-release-cli:

yarn global add semantic-release-cli

Install hub (if you want this generator to be able to create repositories for you):

brew install hub

Then switch to the directory where you want to generate a new project, and run:

yo bxd-oss

Developing

Built With

• Yeoman

Pre-requisites

• NodeJS
• Yarn
• Git

Setting up Dev

Here's a brief intro about what a developer must do in order to start developing the project further:

git clone https://github.com/blackxored/generator-bxd-oss
cd generator-bxd-oss
yarn

After this, you can find the generator in generators/app alongside its templates.

Testing the generator without publishing

yarn link

The above command links this generator into the global modules folder (just remember to unlink it after!).

Versioning

We use SemVer for versioning. In addition, it's automatic via semantic-release, and our commit convention.

For the versions available, see the Releases on this repository.

Style guide

We base our code style on AirBnB's style guide and we check with ESLint and automatically format our code with Prettier.

License

This project is licensed under the MIT License - see the license file for details.

Acknowledgments

• Kent C. Dodds and his generator.
• Hive's project guidelines
• Open Source Guide

Contributing

If you're interested in contributing to this project in any form, please read our Contribution Guidelines.

Code of Conduct

We've adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Contributors

Thanks goes to these people (emoji key):

Adrian Perez 💻 📖 🚇 ⚠️

This project follows the all-contributors specification. Contributions of any kind welcome!