Rename input / output files for GitMetrics

[pvk-developer]

Description

To improve maintainability, clarity, and scalability of the GitMetrics library, we need to standardize and rename both configuration (input) files and generated output files.

Currently, naming conventions are inconsistent, overly generic, and do not clearly communicate:

• What the file contains
• Which workflow generated it
• What time period it represents
• Which library group it applies to

Establishing a consistent and descriptive naming schema will make the system easier to understand, maintain, and extend.

Current Issues

Configuration Files

• config.yaml: Too generic; contains project/repository definitions.
• daily.yaml: Indicates frequency but not content or scope.
• weekly.yaml: Same issue as daily; lacks clarity on what is collected.
• summarize_config.yaml: Not clearly tied to a specific workflow or dataset.

Output Files

• GitHub_Summary.xlsx:

  • Hardcoded and inconsistent naming
  • Lacks context (what is summarized?)
  • Not uploaded to Google Drive

• Consolidated_Overview.xlsx:

  • Hardcoded name
  • Does not clearly describe scope (which libraries?)

Proposed Solution

1. Configuration File Renaming

Current Name	Proposed Name	Description
config.yaml	project_definitions.yaml	Static definitions of project groups and repositories
daily.yaml	daily_extraction_config.yaml	Daily workflow configuration for synthetic data libraries
weekly.yaml	weekly_extraction_config.yaml	Weekly workflow configuration for non-synthetic libraries
summarize_config.yaml	daily_summarization_config.yaml	Explicitly tied to daily summarization workflow

2. Output File Renaming

Current Name	Proposed Name	Notes
GitHub_Summary.xlsx	gitmetrics_growth_summary.xlsx	Daily summary for synthetic data libraries
Consolidated_Overview.xlsx	gitmetrics_consolidated_summary_to_date.xlsx	Consolidated summary for all other libraries