Skip to content

Commit 8b4cec7

Browse files
authored
merge(#2): readme
Add README
2 parents 0cde165 + 90fa800 commit 8b4cec7

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
2+
[![Maintainability](https://api.codeclimate.com/v1/badges/0ef7545d395120222d77/maintainability)](https://codeclimate.com/github/andre-filho/commit-helper/maintainability)
3+
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/595af9a088cf44e19ec2679a8c2617f6)](https://www.codacy.com/app/andre-filho/commit-helper?utm_source=github.com&utm_medium=referral&utm_content=andre-filho/commit-helper&utm_campaign=Badge_Grade)
4+
5+
# Commit Helper
6+
---
7+
## What does it do?
8+
The commit-helper do exactly what it's name suggest: helps you create and maintain your commit policy by tailoring your commit message into a commit comvention.
9+
10+
## Why should I use this?
11+
Keeping a commit policy may sound like an easy thing to do, but in reality we both know that it isn't.
12+
13+
Sometimes we, the devs, go _full-loco_ while programming and make mistakes when commiting. That's fine, everyone makes mistakes. But, what if those mistakes could be avoided?
14+
15+
## Project's maintainers
16+
| **Name** | **Username** |
17+
| :--------: | :-----: |
18+
| André de Sousa Costa Filho | andre-filho |

0 commit comments

Comments
 (0)