Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #277 from h1alexbel/start
start(#227): fetch topics for repos too, document /steps in steps/README.md
- Loading branch information
Showing
3 changed files
with
24 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
## Gathering Steps | ||
|
||
The entire process of gathering metrics from GitHub repos consists of these | ||
steps: | ||
|
||
* **Discovering**. Here we fetch the list of repos from GitHub and then create | ||
directories for them. | ||
* **Polishing**. Then we delete directories that don't exist in the list of | ||
required repositories. | ||
* **Unregistering**. During this step, we clean directories from the CSV | ||
register if their clones are absent. | ||
* **Cloning**. In this step we run `git clone` on found repositories. | ||
* **JPEEK**. Here, we build those gathered repositories and run | ||
[jpeek](https://github.com/cqfn/jpeek) on them. | ||
* **Filtering**. Is where we apply [all the filters](https://github.com/yegor256/cam/tree/master/filters) | ||
in order to get rid of irrelevant classes (such as `*Test`, `*ITCase`, invalid | ||
files and so on). Whole filtering process will be printed in the final report, | ||
you can check it [here](http://cam.yegor256.com/cam-2024-03-02.pdf). | ||
* **Measuring**. We calculate metrics for each file using these [metrics](https://github.com/yegor256/cam/tree/master/metrics). | ||
* **Aggregating**. Finally, we aggregate all metrics in summary CSV files. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters