Skip to content

Commit fe40225

Browse files
mafesanAlberto Pérez García-Plaza
authored and
Alberto Pérez García-Plaza
committed
[chaoss][doc] Add documentation for Lines of Code Changed panel
1 parent fbcb91e commit fe40225

File tree

2 files changed

+53
-0
lines changed

2 files changed

+53
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
title: Lines of Code Changed
3+
description: panel focused on the number of lines of code changed.
4+
author: Miguel-Ángel Fernández Sánchez
5+
created_at: 2018-01-16
6+
grimoirelab_version: 0.2.3
7+
layout: panel
8+
---
9+
10+
11+
This panel focuses on **Number of lines of code changed**. We based the panel on Git data.
12+
13+
The idea behind the panel is having a look on how community contributes to the repositories by having a look at the magnitude of those changes with several metrics related with Git commits, specially modified lines and the amount of affected files. By using this panel we can identify and analyze behaviors of specific organizations, projects or repositories.
14+
15+
There are some filters added by default for the whole panel:
16+
17+
* `NOT Merges`: It ignores those commits whose number of modified files is 0 (this is, commits from merges).
18+
* `NOT Bots`: It ignores those commits whose author is marked as a Bot.
19+
20+
### What should I look for in the panel?
21+
22+
If in this panel we observe a given project or repository in an early stage, we expect to observe a higher number of modified lines (presumably, more added lines than removed) in a narrower time-range. That would correspond with high peaks in the **Evolution of lines added vs lines removed** chart.
23+
24+
If that project has became stable, the expected number of modified lines will be smaller than before, but keeping in mind the value wouldn't vary drastically except for events such code refactoring or major updates.
25+
26+
If we are looking at a project in close to its final days, we expect the number of modified lines would decrease significantly, and we would not observe high peaks even considering wider time-ranges.
27+
28+
### List of metrics provided on the panel
29+
* **Number of authors**: number of authors who modified at least one file within the selected time-frame.
30+
* **Median modified files**: Median amount of files changed (at least one line added or removed) per commit in a given time-frame.
31+
* **Number of added lines**: Amount of new lines in all commits from a given time-frame.
32+
* **Number of removed lines**: Amount of deleted lines in all commits from a given time-frame.
33+
* **Evolution of lines added vs lines removed**: evolution of number of added/removed lines during the selected time range.
34+
* **Evolution of commits**: evolution of number of commits during the selected time range, per project.
35+
36+
37+
![Lines of Code Changed]({{ site.baseurl }}/assets/images/chaoss-gmd-cde/lines_of_code_changed.png)
38+
###### Figure 1. Lines of Code Changed Panel
39+
40+
41+
Filtering by Organization and Project is allowed by using the top left corner
42+
widget.
43+
44+
**Number of authors**, **Median modified files**, **Number of added lines** and **Number of removed lines** are shown below the filtering widget.
45+
These are global numbers to have an idea about the amount of data we are visualizing
46+
with current filters. The number of commits per repository is shown at the right hand side, within
47+
repositories table.
48+
49+
**Evolution of lines added vs lines removed** is almost centered in the panel, between the filter widget and repositories table. It shows an area graph showing the amount of added lines above the X-axis and the amount of removed lines below the X-axis, from the commits within period selected in time picker, on the top right corner.
50+
51+
**Evolution of commits** is below the last graph, between the big numbers widget and repositories table. It shows bar chart where each bar represents the amount of commits in a given time (depending on the granularity of the graph it could be hours, days, weeks, months, etc.). Each bar is split by project.
52+
53+
Finally, a short text is shown at the bottom to explain the basics needed to understand the panel and its filters.
Loading

0 commit comments

Comments
 (0)