analyzing.html.erb
3.41 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
<h1>Tutorial</h1>
<h2>Analyzing a repository</h2>
<hr />
<h3>Requisites</h3>
In order to create a Project, you must:
<ul>
<li>Have <%= link_to("signed up", new_user_registration_path) %> to the platform</li>
<li>Be <%= link_to("signed in", new_user_session_path) %></li>
<li>And have a repository URL which you wish to analyze</li>
</ul>
<hr />
<h3>Steps</h3>
<ol>
<li>Project creation
<ol>
<li>Click on "Project" on the upper menu</li>
<li>Click on "New Project"</li>
<ol>
<li>Fill in the form with a name that must be unique</li>
<li>Fill in the form with a description which is not required</li>
<li>Click on "Save" and you should be at the project page now, congratulations!</li>
</ol>
</ol>
<li>Repository creation</li>
<ol>
<li>From the project page, click on "New Repository"</li>
<li>Fill in the form</li>
<ul>
<li>"Name" must be unique</li>
<li>You should choose one of the Open Source licenses in the platform according to your code</li>
<li>The "Type" field stands for the Repository source code management tool (Git, for example)</li>
<li>Fill in the "Address" with the URL from which we can download your code</li>
<li>If you want to analyze your project periodically, set it (you can as well run it from the interface whenever you want)</li>
<li>Finally, the "Configuration" stands for the set of metrics and interpretation that we will use to analyze your project</li>
<li>Click on "Save" and you should be at the repository page, waiting for the analysis</li>
</ul>
</ol>
</ol>
<hr />
<h3>Repository page details</h3>
The repository page is divided into four different sections:
<ol>
<li><b>Details</b></li>
<ul>
<li>Information that you provided during the creation steps</li>
<li>Select box so it is possible to visualize previous processings of your repository</li>
</ul>
<li><b>Processing information</b></li>
<ul>
<li>Information about the time it has taken to finish each step of the processing</li>
<ol>
<li>PREPARING: the system is reserving a folder for your repository and retrieving the configuration</li>
<li>DOWNLOADING: retrieving the source code</li>
<li>COLLECTING: calculating the metrics for your repository</li>
<li>BUILDING: organizing the results into a source tree structure</li>
<li>AGGREGATING: calculating the aggregated value for parent modules in the source tree</li>
<li>CALCULATING: if the chosen configuration has compound metrics, they will be calculated</li>
<li>INTERPRETING: with all the necessary results, the system will interpret them using reading groups (labels and colors)</li>
</ol>
</ul>
<li><b>Modules Tree</b></li>
<ul>
<li>Source tree structure where you can navigate by clicking on the names
<li>Information about the granularity of the module
<ul>
<li>METHOD</li>
<li>CLASS</li>
<li>PACKAGE</li>
<li>SOFTWARE</li>
</ul>
<li>Grade of the given module according to the weights of the metrics on the configuration
</ul>
<li><b>Metric Results</b></li>
<ul>
<li>Displays the individual results of each metric for the current module selected in the source tree</li>
<li>By clicking on the metric name, you will see a historic chart for that metric</li>
</ul>
</ol>