https://github.com/meyskens/are-you-a-docs-person
Experimental repo to get statistics on documentation using source{d} software
https://github.com/meyskens/are-you-a-docs-person
Last synced: about 1 month ago
JSON representation
Experimental repo to get statistics on documentation using source{d} software
- Host: GitHub
- URL: https://github.com/meyskens/are-you-a-docs-person
- Owner: meyskens
- Created: 2018-10-08T15:30:46.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-10-08T16:30:40.000Z (over 6 years ago)
- Last Synced: 2025-01-22T05:17:29.823Z (3 months ago)
- Language: Go
- Size: 3.91 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
Are you a docs ~person~ repo?
============================
This is a small project inspired by an idea of [Carolyn Van Slyck](https://github.com/carolynvs) to calculate the amount of documentation ~contributions~ vs documentation ~contributions you have done on GitHub~ per repository.
This project makes use of [gitbase](https://github.com/src-d/gitbase) to query the repositories and [Babelfish](https://github.com/bblfsh/bblfshd) to filter any in code comments (eg. GoDoc).
## Why the pivot?
The goal of this project is to test the above listed projects, since gitbase lacked needed features I changed to working on a repo basis only looking at the HEAD.
## Results?
I did not have enough query time and resources to do everything I wanted but one metric worked fine:
```
https---github.com-BurntSushi-toml is 11.111111 % markdown
https---github.com-Masterminds-semver is 14.285714 % markdown
https---github.com-alecthomas-kingpin is 2.564103 % markdown
https---github.com-agext-levenshtein is 9.090909 % markdown
```