Skip to content

Instantly share code, notes, and snippets.

@sebastienbarre

sebastienbarre/README.md

Created November 28, 2015 04:40
Show Gist options
  • Save sebastienbarre/d5aa892a86980a57bec2 to your computer and use it in GitHub Desktop.
Save sebastienbarre/d5aa892a86980a57bec2 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
README.md

SELF

Build Status Coverage Status Dependencies Status Node Version License semantic-release Commitizen friendly

SELF is...

Table of Contents

Installation

Requirements

Usage

Examples

Thanks

Troubleshooting

Authors

Sebastien Barre

Contribute

  • Check for open issues, especially the ones up-for-grabs, or open a fresh issue to start a discussion around a feature idea or a bug.
  • If you feel uncomfortable or uncertain about an issue or your changes, feel free to email me and I will happily give you a hand.
  • Fork the repository on GitHub to start making your changes to the master branch (or branch off of it).
  • Write a test which shows that the bug was fixed or that the feature works as expected.
  • Do not use git commit to commit your code; use npm run commit instead; this will ensure a Commitizen-friendly commit message will be generated, a convention that will in turn be leveraged by semantic-release.
  • Send a pull request and notify me :) Thanks.

License

This software is released under the BSD License.

Change Log

All notable changes to this project are documented automatically on the Github releases page. This project believes in Semantic Versioning and Keep a CHANGELOG. It uses commitizen and semantic-release to help with that endeavor.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment