Skip to content

Commit 8a46611

Browse files
Add some badges to the README, remove some spaces
1 parent 730e554 commit 8a46611

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
## gitpert
1+
[![GoDoc](https://godoc.org/github.com/augmentable-dev/gitpert?status.svg)](https://godoc.org/github.com/augmentable-dev/gitpert)
2+
[![Go Report Card](https://goreportcard.com/badge/github.com/augmentable-dev/gitpert)](https://goreportcard.com/report/github.com/augmentable-dev/gitpert)
3+
[![TODOs](https://badgen.net/https/api.tickgit.com/badgen/github.com/augmentable-dev/gitpert)](https://www.tickgit.com/browse?repo=github.com/augmentable-dev/gitpert)
4+
5+
# gitpert
26

37
`gitpert` measures the "pertinence" of git authors as a time-decayed measure of LOC added and removed to a repository (or a set of files in a repository).
48
It's meant to help identify who the most relevant contributors are based on commit recency, frequency and impact.
@@ -12,24 +16,19 @@ The net effect *should* be a ranked list of authors (contributors) where those w
1216
This could be useful for identifying who the best person to review a new code change might be, or who the best person to ask questions or seek help from might be. Scores can be done at the repository level, and also for individual files (the most pertinent author for a repository might not be the most pertinent for a directory or file within that repository).
1317

1418

15-
### Installation
16-
19+
## Installation
1720
TODO
1821

19-
### Usage
20-
22+
## Usage
2123
TODO
2224

23-
### FAQ
24-
25-
#### What about git-blame?
25+
## FAQ
2626

27+
### What about git-blame?
2728
`git-blame` will tell you about the last modification to lines in a file (the author and revision), and is certainly useful. This tool hopes to provide a higher level view of the net effect of authorship in a repository over time.
2829

29-
#### Why are changes to "vendored" dependencies ignored?
30-
30+
### Why are changes to "vendored" dependencies ignored?
3131
Authoring a commit that introduces a large diff because it adds or removes many dependencies (think the `vendor/` directory in golang projects), though in most contexts an important contribution, gives an outsized "impact" to that commit and author which doesn't necessarily reflect how well they "impact" the code of the project itself in that commit.
3232

33-
#### Should LOC added be weighed the same as LOC removed?
34-
35-
Maybe. This could be worth exposing as a config parameter. One could argue that a LOC added should weigh some amount more than a LOC removed.
33+
### Should LOC added be weighed the same as LOC removed?
34+
Maybe. This could be worth exposing as a config parameter. One could argue that a LOC added should weigh some amount more than a LOC removed.

0 commit comments

Comments
 (0)