yegor256/cam

create `data/summary/{metric}.csv` files

Open

#230 opened on Mar 21, 2024

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Shell (51 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (27 stars)
PR merge metrics
 (PR metrics pending)

Description

For each metric, let's make steps/aggregate.sh create data/summary/{metric}.csv files, which will have the following structure (for example, data/summary/LOC.csv):

repository,count,sum,average,mean,min,max
yegor256/cam,28,500,45.3,48.2,1,90
yegor256/cactoos,...
yegor256/takes,...

Here:

  • 28 is the number of .m files generated for the repository
  • 500 is the summary of all LOC metric values for all files in the yegor256/cam repo
  • 45.3 is the arithmetic average
  • 48.2 is the mean
  • 1 is the smallest value of LOC in the repo
  • 90 is the largest value of LOC in the repo

Maybe we can create a new additional step for this sumarization (like steps/summarize.sh)

Contributor guide

Research direction
Examine the existing `steps/aggregate.sh` to understand how metrics are currently computed, then implement a new script (e.g., `steps/summarize.sh`) that reads per repository metric files and outputs a CSV with count, sum, average, mean, min, max for each metric.
Tech stack
shell
Domain
data
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Shell
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70