Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Track documentation contributors and submitters #9

Open
sagesharp opened this issue Nov 7, 2016 · 0 comments
Open

Track documentation contributors and submitters #9

sagesharp opened this issue Nov 7, 2016 · 0 comments

Comments

@sagesharp
Copy link
Owner

It would be good to acknowledge those contributors who write documentation as part of a pull request.

What could we use the data for?

We could use that information to see what the ramp-up time is for newcomers to start writing documentation. It would also be useful to see what percentage of core contributors write documentation. The data could be used to test hypothesis around whether newcomers ramp up faster when interacting with projects with good documentation. Another interesting hypothesis to test would be whether code contributions without documentation are more or less likely to contain bugs.

How to tell if someone is writing documentation

We could look at the file extension and see if it's .md, .txt, .html, etc. Some people may be documenting things with Jupyter Notebooks or literate Haskell, and I'm not sure how to handle that. If we could figure out what language file we're reading from, we could parse the number of comment lines added or deleted.

Getting data out of github

Unfortunately, github pull request json file doesn't list which files are touched by the pull request. ghscraper.py would need to be modified to pull down more information.

sagesharp added a commit that referenced this issue Nov 8, 2016
Additional ideas for expanding the data we gather and bugs are
documented in issues #7, #8, #9, and #10.

Signed-off-by: Sarah Sharp <sharp@otter.technology>
sagesharp added a commit that referenced this issue Nov 8, 2016
Signed-off-by: Sarah Sharp <sharp@otter.technology>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant