harshalmittal4 / chaoss-perceval-microtasks

Visualization of Github statistics of any open-source project using Github API and CHAOSS project.

CHAOSS-Perceval-microtasks

This repository contains microtasks to achieved for CHAOSS GSoC Idea #2 :
Implementing CHAOSS metrics with Perceval Details.
(Launch with Binder)

---

#Microtask 0

Using (See in MyBinder) as an example, produce one notebook per data source (git, GitHub/GitLab issues, GitHub pull requests / GitLab merge requests) showing a summary of the contents of that file (number of items in it, and number of different identities in it counting authors/committers for git, submitters for issues and pull/merge requests). This microtask is mandatory, to show that you can retrieve data and produde a notebook showing it. In each notebook, include also the list of repositories retrieved, and the date of retrieval, using data available in the JSON file.

The task is completed here.

---

#Microtask 1

Produce a notebook showing (and producing) a list with the activity per quarter: number of new committers, submitters of issues, and submitters of pull/merge requests, number of items (commits, issues, pull/merge requests), number of repositories with new items (all of this per quarter) as a table and as a CSV file. Use plain Python3 (eg, no Pandas) for this.

The task is completed here.

---

#Microtask 2

Like Microtask 1, but now using Pandas.

The task is completed here.

---

#Microtask 3

Produce a notebook with charts showing the distribution of time-to-close for issues already closed, and opened during the last year, for each of the repositories analyzed, and for all of them together. Use Pandas for this, and the Python charting library of your choice (as long as it is a FOSS module).

The task is completed here.

---

#Microtask 4

Produce a listing of repositories, as a table and as CSV file, with the number of commits authored, issues opened, and pull/merge requests opened, during the last three months, ordered by the total number (commits plus issues plus pull requests). Use plain Python3 (eg, no Pandas) for this.

The task is completed here.

---

#Microtask 5

Like Microtask 4, but now using Pandas.

The task is completed here.

---

#Microtask 6

Perform any other analysis you may find interesting, based on the Perceval data you collected.

The task is completed here.

---

#Microtask 7-8

Contributions uptil now are included here.

---

To produce the results :

1. Clone the repo. In the root of the directory, create a virtualenv and set it to use python3 (in case default is python2):

$ python3 -m virtualenv venv
$ virtualenv --python=/path/to/yourpython3 venv

2. Activate the virtualenv.

source ./venv/bin/activate

3. Install the required packages.

$ pip install -r requirements.txt

4. Launch the jupyter kernel.

$ jupyter-notebook

The readme.md in each folder contains further information for that microtask.

chaoss-perceval-microtasks's Issues

Suggestions regarding improvement in the microtasks.

Hey @valeriocos, @aswanipranjal, I would be adding the microtask 6 soon. Meanwhile, please may you review these microtasks for any changes I need to have, or the improvements you feel.

One things that I wished to ask was regarding the extent of documentation. Although I would be adding some more parts to the documentation(had been busy with some university stuff), just thought to have your remarks on it (It could be made as much descriptive as required by adding more details).

The proposal is almost done and would be in place by tomorrow. I am making some final changes.
I request you to review the proposal also once it is finalized, this would be of great help!
Thanks 🙂