User Tools

Site Tools


chaoss:gsoc-ideas

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
chaoss:gsoc-ideas [2018/01/23 16:17]
GeorgLink
chaoss:gsoc-ideas [2018/03/21 15:56] (current)
GeorgLink
Line 1: Line 1:
 +[[chaoss:​start|<<​ Back to CHAOSS start page]] ]
 +
 +{{:​chaoss:​chaoss_logo_pantone_2_.png?​400|}}
 ====== Ideas for Google Summer of Code projects ====== ====== Ideas for Google Summer of Code projects ======
  
 +===== Idea #1: Support of Standard CHAOSS Formats for Description of Projects =====
  
-=====  Idea #1Reporting of CHAOSS Metrics =====+[ [[https://​github.com/​chaoss/​grimoirelab/​issues/​71|Micro-tasks and place for questions]] ]
  
- +Currently, GrimoireLab uses its own format for describing a project, including the data sources (repositories to retrieve information from), the internal organization of the project (e.g., in subprojects),​ and specifics about how the data is to be presented. For this information,​ some standard formats already exist, that can be directly used, or used with some modifications. Among them, [[https://​en.wikipedia.org/​wiki/​DOAP|DOAP]] ​is one of the most interesting ones, but there are many others.
-Currently, [[https://​grimoirelab.github.io/​|GrimoireLab]] includes a tool for reporting: Manuscripts. This tool reads data from a GrimoireLab ElasticSearch database, and produces with it a PDF report with relevant metrics for a set of analyzed projects. Internally, Manuscripts uses some Python code to produce charts and CSV tables, which are integrated into a LaTeX document to produce the final PDF. Other approaches, such as producing Jupyter notebooks, will be explored too. +
- +
-This idea is about adding support to Manuscripts to produce reports based on the work of the CHAOSS Community. Since Manuscripts is still a moving target, this will be also a chance to participate in the general development of the tool itself, to convert it into a generic reporting system for GrimoireLab data. +
- +
-The aims of the project are as follows:  +
- +
-  * Writing Python code to query GrimoireLab Elastisearch databases and obtain from it the metrics relevant for the report. Possible technologies to achieve this aim include Python Pandas. +
-  * Writing Python code to produce suitable representation for those metrics, such as tables and charts. +
-  * Adapting current tools to produce reports directly from data sources, by managing the GrimoireLab toolchain. Possible solutions include adding the code to Mordred, the tool orchestrating GrimoireLab tools. +
- +
-Other aims, such as producing Jupyter notebooks as a final result or an intermediate step are completely within scope. +
- +
-  * //​Difficulty://​ easy/​medium +
-  * //​Requirements://​ Python programming. Interest in software analytics. Willingness to understand GrimoireLab internals. +
-  * //​Recommended://​ Experience with Python interfaces to databases would be convenient, but can be learned during the project. Experience with Latex and/or Python Jupyter Notebooks would help. +
-  * //​Mentors://​ Jesus M. Gonzalez-Barahona,​ Matt Germonprez, Jordi Cabot +
- +
-===== Idea #2: Support of Standard CHAOSS Formats for Description of Projects ===== +
- +
- +
-Currently, GrimoireLab uses its own format for describing a project, including the data sources (repositories to retrieve information from), the internal organization of the project (e.g., in subprojects),​ and specifics about how the data is to be presented. For this information,​ some standard formats already exist, that can be directly used, or used with some modifications. Among them, DOAP is one of the most interesting ones, but there are many others.+
  
 This idea is about identifying formats used by projects to describe themselves and adding support to GrimoireLab. This includes not only static formats, but also APIs. This idea is about identifying formats used by projects to describe themselves and adding support to GrimoireLab. This includes not only static formats, but also APIs.
Line 44: Line 27:
   * //​Recommended://​ Experience with Python HTTP and XML libraries would be convenient, but can be learned during the project.   * //​Recommended://​ Experience with Python HTTP and XML libraries would be convenient, but can be learned during the project.
   * //​Mentors://​ Jesus M. Gonzalez-Barahona,​ Valerio Cosentino   * //​Mentors://​ Jesus M. Gonzalez-Barahona,​ Valerio Cosentino
 +
 +
 +
 +=====  Idea #2: Reporting of CHAOSS Metrics =====
 +
 +[ [[https://​github.com/​chaoss/​grimoirelab/​issues/​70|Micro-tasks and place for questions]] ]
 +
 +Currently, [[https://​grimoirelab.github.io/​|GrimoireLab]] includes a tool for reporting: Manuscripts. This tool reads data from a GrimoireLab ElasticSearch database, and produces with it a PDF report with relevant metrics for a set of analyzed projects. Internally, Manuscripts uses some Python code to produce charts and CSV tables, which are integrated into a LaTeX document to produce the final PDF. Other approaches, such as producing Jupyter notebooks, will be explored too.
 +
 +This idea is about adding support to Manuscripts to produce reports based on the work of the CHAOSS Community. Since Manuscripts is still a moving target, this will be also a chance to participate in the general development of the tool itself, to convert it into a generic reporting system for GrimoireLab data.
 +
 +The aims of the project are as follows: ​
 +
 +  * Writing Python code to query GrimoireLab Elastisearch databases and obtain from it the metrics relevant for the report. Possible technologies to achieve this aim include Python Pandas.
 +  * Writing Python code to produce suitable representation for those metrics, such as tables and charts.
 +  * Adapting current tools to produce reports directly from data sources, by managing the GrimoireLab toolchain. Possible solutions include adding the code to Mordred, the tool orchestrating GrimoireLab tools.
 +
 +Other aims, such as producing Jupyter notebooks as a final result or an intermediate step are completely within scope.
 +
 +  * //​Difficulty://​ easy/medium
 +  * //​Requirements://​ Python programming. Interest in software analytics. Willingness to understand GrimoireLab internals.
 +  * //​Recommended://​ Experience with Python interfaces to databases would be convenient, but can be learned during the project. Experience with Latex and/or Python Jupyter Notebooks would help.
 +  * //​Mentors://​ Jesus M. Gonzalez-Barahona,​ Matt Germonprez, Jordi Cabot
 +
  
  
 ===== Idea #3: Prototype New CHAOSS Metrics ​ ===== ===== Idea #3: Prototype New CHAOSS Metrics ​ =====
  
 +[ [[https://​github.com/​OSSHealth/​ghdata/​issues/​82|Micro-tasks and place for questions]] ]
  
-Library ​that can be used by CHAOSS Community Software projects like GHData to express open source software project level similarities. There are two components: A set of algorithms for integrating similarity measures on an array of project data and implementation of visualizations using our existing framework and possibly adding to the framework. ​+Create a library ​that can be used by CHAOSS Community Software projects like GHData to express open source software project level similarities. There are two components: A set of algorithms for integrating similarity measures on an array of project data and implementation of visualizations using our existing framework and possibly adding to the framework. ​
  
  
 The aims of the project are as follows: ​ The aims of the project are as follows: ​
-  - Build new metric ​in a Python/​Flask/​MetricsJS open source project ​called ​[[http://​www.github.com/​OSSHealth/​ghdata|"GHData"]]. This will familiarize our summer of code participant ​with different metrics as currently defined by the Linux Foundation ​CHAOSS ​Project, as well as introduce ​them to the primary ​user interaction design goals of :  +  - Build new metrics ​in a Python/​Flask/​MetricsJS ​for the open source project [[http://​www.github.com/​OSSHealth/​ghdata|GHData]]. This will create familiarity ​with different metrics as currently defined by the CHAOSS ​project, as well as introduce user interaction design goals of:  
-    - Enabling comparisons between GitHub, Mozilla and other open source project repositories and projects as a default design mechanism +    - Enabling comparisons between GitHub, Mozillaand other open source project repositories and projects as a default design mechanism. 
-    - Considering the different ways of building software to do temporal comparisons +    - Considering the different ways of building software to do temporal comparisons. 
-  - Build machine learning algorithms that identify candidate “toxic interactions” in open source mailing lists and IRC channels, with the aim of making open source a more welcoming environment for diverse populations +  - Build machine learning algorithms that identify candidate “toxic interactions” in open source mailing lists and IRC channels, with the aim of making open source a more welcoming environment for diverse populations. 
-  - Design and evaluate exploratory mechanisms for presenting project data, metrics and analysis using a complex, hierarchical and networked set of data structures. ​ For example, there are main ways a commit” is defined in open source software: a) The explicit, individual ​commit” record and b) unique commits. For each of these metrics, which can be reasonably ​easily ​calculated from source repositories,​ there are interests in CHOASS project stakeholders in understanding them: +  - Design and evaluate exploratory mechanisms for presenting project data, metricsand analysis using a complex, hierarchicaland networked set of data structures. ​ For example, there are two main ways a "commit" ​is defined in open source software: a) The explicit, individual ​"commit" ​record and b) "unique commits". For each of these metrics, which can be reasonably calculated from source repositories,​ there are interests in CHOASS project stakeholders in understanding them: 
     - By project     - By project
     - Project organization     - Project organization
Line 64: Line 72:
     - Individual     - Individual
     - Corporate organization     - Corporate organization
-    - Roles in a project (people evolving from the periphery to the core, for example).+    - Roles in a project (including ​people evolving from the periphery to the core).
  
 Each of these are significant opportunities for a Google Summer of Code participant to engage and learn and become part of a project. ​   Each of these are significant opportunities for a Google Summer of Code participant to engage and learn and become part of a project. ​  
Line 72: Line 80:
   * //​Requirements://​ Python programming. Networking Basics, JavaScript Basics   * //​Requirements://​ Python programming. Networking Basics, JavaScript Basics
   * //​Recommended://​ Experience with Python HTTP and XML libraries would be convenient, but can be learned during the project.   * //​Recommended://​ Experience with Python HTTP and XML libraries would be convenient, but can be learned during the project.
-  * //​Mentors://​ Sean Goggins, Jesus M. Gonzalez-Barahona+  * //​Mentors://​ Sean Goggins, Jesus M. Gonzalez-Barahona, Josianne Marsan 
 + 
 + 
chaoss/gsoc-ideas.1516724249.txt.gz · Last modified: 2018/01/23 16:17 by GeorgLink