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