Tutorial

Analyzing a repository

Requisites

• Have <%= link_to("signed up", new_user_registration_path) %> to the platform
• Be <%= link_to("signed in", new_user_session_path) %>
• And have a repository URL which you desire to analyze

Steps

1. Project creation
   1. Click in "Project" on the upper menu
   2. Click in "New Project" on the upper menu
   1. Fill in the form with a name that must be unique
   2. Fill in the form with a description which is not required
   3. Click in "Save" and you should be at the project page now, congratulations!
2. Repository creation
1. From the project page, click in "New Repository"
2. Fill in the form
• "Name" must be unique
• You should choose from one of the Open Source licenses in the platform accordingly to your code
• The "Type" field stands for the repository's source code management tool (eg: Git)
• Fill in the "Address" with a URL from which we can download your code
• If you want to analyze your project periodically, set it (you can as well run it from the interface whenever you want)
• Finally, the "Configuration", stands for the settings for metrics and interpretation that we'll use to analyze your project
• Click in "Save" and you should be at the repository page, waiting for tha analysis

Repository page details

1. Details
• Information that you provided during the creation steps
• Select box so it is possible to visualize previous precessings for your repository
2. Processing information
• Information about the time that has taken to finish each step of the processing
1. PREPARING: the system is reserving a folder for your repository and retrieving the configuration
2. DOWNLOADING: retrieving the source code
3. COLLECTING: extracting the metrics for your repository
4. BUILDING: organizing the results into a source tree structure
5. AGGREGATING: calculating the aggregated value for parent modules in the source tree
6. CALCULATING: if the choosen configuration has compund metrics, they will be calculated
7. INTERPRETATING: with all the necessary results, now the system will interpretate this results in means of the reading group (labels and colors)
3. Modules Tree
• Source tree structure where you can navigate by clicking on the names
• Information about the granularity of the module
  • METHOD
  • CLASS
  • PACKAGE
  • SOFTWARE
• Grade of the given module accordingly to the weights of the configuration
4. Metric Results
• Displays the individual results for each metric for the current module selected in the source tree
• By clicking in the metric name, you will see a historic chart for that metric