jenkins-project-cli/contributing.md

jenkins command line interface

> cli wrapper for jsonlint

<p align="center">
  <h1>jenkins-cli</h1>
</p>

Yeay! You want to contribute to jenkins-cli. That's amazing!
To smoothen everyone's experience involved with the project please take note of the following guidelines and rules.

## Found an Issue?
Thank you for reporting any issues you find. We do our best to test and make jenkins-cli as solid as possible, but any reported issue is a real help.

> jenkins-cli issues

Please follow these guidelines when reporting issues:
* Provide a title in the format of `<Error> when <Task>`
* Tag your issue with the tag `bug`
* Provide a short summary of what you are trying to do
* Provide the log of the encountered error if applicable
* Provide the exact version of jenkins-cli. Check `npm ls jenkins-cli` when in doubt
* Be awesome and consider contributing a [pull request](#want-to-contribute)

## Want to contribute?
You consider contributing changes to jenkins-cli – we dig that!
Please consider these guidelines when filing a pull request:

> jenkins-cli pull requests

* Follow the [Coding Rules](#coding-rules)
* Follow the [Commit Rules](#commit-rules)
* Make sure you rebased the current master branch when filing the pull request
* Squash your commits when filing the pull request
* Provide a short title with a maximum of 100 characters
* Provide a more detailed description containing
	* What you want to achieve
	* What you changed
	* What you added
	* What you removed

## Coding Rules
To keep the code base of jenkins-cli neat and tidy the following rules apply to every change

> Coding standards

* [Happiness](/sindresorhus/xo) enforced via eslint
* Favor micro library over swiss army knives (rimraf, ncp vs. fs-extra)
* Coverage never drops below 90%
* No change may lower coverage by more than 5%
* Be awesome

## Commit Rules
To help everyone with understanding the commit history of jenkins-cli the following commit rules are enforced.
To make your life easier jenkins-cli is commitizen-friendly and provides the npm run-script `commit`.

> Commit standards

* [conventional-changelog](/commitizen/cz-conventional-changelog)
* husky commit message hook available
* present tense
* maximum of 100 characters
* message format of `$type($scope): $message`


---
Copyright 2016 by [Mario Nebl](https://github.com/marionebl) and [contributors](./graphs/contributors). Released under the [MIT license]('./license.md'). The jenkins logo is released under the [Creative Commons Attribution-ShareAlike 3.0 Unported License](http://creativecommons.org/licenses/by-sa/3.0/) and created by the [jenkins project](https://wiki.jenkins-ci.org/display/JENKINS/Logo)