README
JIRAPTOR
About
JIRAPTOR uses the Atlassian Smart Commit model to document code changes through Git.
Smart Commit model:
<PROJECT_PREFIX>-<NUMBER_ID>
E.g.:
"JIRAP-650 Added X feature."
Installation
Be sure to install it globally.
npm install jiraptor -g
Important
You must be using one of the following models for branch creation to use this package:
<TYPE>/<PREFIX>-<NUMBER_ID>-<MESSAGE>
<PREFIX>-<NUMBER_ID>-<MESSAGE>
E.g.:
"Feature/JIRAP-620-Add-Z-feature."
Setup
Add jiraptor-config.json
file in your project directory and include your project prefix:
{
"prefix": "<PROJECT-PREFIX>"
}
jiraptor
or jirap
and you're good to go!
Finally, type Parameters
JIRAPTOR asks for 2 params:
- Commit message
- Push after commit (defaults to true)
Contributions
JIRAPTOR is an open-sourced package. Contributions of any shape are welcome and appreciated.
License
The MIT License (MIT)
Copyright (c)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Source: http://opensource.org/licenses/MIT