README.md

^{Open-source magic tools | Terra-firma for Open-Source Ecmascript projects !}

---

---

Website | Wiki | Issues | Contributing

Built with 💗 by Kane Thornwyrd and contributors

---

Table of Contents

• Features
• Workflow
• Example
• Philosophy
• Installation
• See Also
• Contributing
• License

Features

• A feature
• Another one
• And a final third ! :)

_{⇧ back to top}

Workflow

⚠️ Use Hubflow ⚠️

Daily usage

1. npm i
2. git hubflow feature start [name of your feature]
3. Do your job
4. git add what you need to add
5. Use ./commit instead of git commit …
6. Follow the instructions
7. Once you are done with your feature:
   git hubflow feature finish [name of your feature]

Release

1. npm run release
2. Follow the instructions

_{⇧ back to top}

Example

This is not the proper way to use the boilerplate but a placeholder for your code exemples.

console.log('Yeay') // console.log is pretty dated, take a look at remote debugging, it's available in VSCode for exemple.

Want to see more examples? Check out the Wiki.

_{⇧ back to top}

Philosophy

The goal here is to provide a good base to start any open-source project automatising the most we can, because, let's face it, it's better to be smart lazy and to focus on coding/delivering than setting up those tools.

_{⇧ back to top}

Installation

This is not the proper way to use the boilerplate but a placeholder for your project installation instructions.

$ npm i -S my-project

_{⇧ back to top}

See Also

• Feedmereadmes - Feedmereadmes ReadMe maturity model
• choo - from which I broadly borrowed inspiration for this README.md

_{⇧ back to top}

Contributing

Please take a look at our contributing guidelines if you're interested in helping!

_{⇧ back to top}

License

This project is licensed under the General Public License v3.0 - see the LICENSE file for details.

_{⇧ back to top}