Skip to content

Reorganize project layout into /data and /scripts and refresh README for production-quality onboarding - #2

Merged
NN-Coder merged 2 commits into
mainfrom
copilot/update-project-file-structure
Jul 14, 2026
Merged

Reorganize project layout into /data and /scripts and refresh README for production-quality onboarding#2
NN-Coder merged 2 commits into
mainfrom
copilot/update-project-file-structure

Conversation

Copilot AI commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

This PR restructures the repository so datasets and analysis code are cleanly separated, then updates runtime/docs to match the new layout. It also expands the README into a full project-level reference with provenance, analysis context, and clear execution guidance.

  • Repository structure

    • Moved CSV assets to data/ (constructors.csv, results.csv).
    • Moved Python analysis entrypoints to scripts/ (main.py, scatter-plot.py, interactive-scatter-plot.py).
  • Runtime path updates

    • Updated all scripts to load datasets from data/ using path resolution relative to script location (instead of assuming repository-root CSV paths).
    • Updated Docker default command to run scripts/main.py.
  • README overhaul

    • Rewrote README into a full project description (goals, methodology, script responsibilities, interpretation notes).
    • Added explicit data provenance for constructors.csv and results.csv from Kaggle:
      https://www.kaggle.com/datasets/rohanrao/formula-1-world-championship-1950-2020
    • Added presentation link for analysis process/context:
      https://docs.google.com/presentation/d/1bZhT_yq7-mdMf9Ao8VaFRqklGW-47c8zOK8FQtB8lGk/edit?usp=sharing
    • Added clean local and Docker run instructions aligned with the new folder structure.
from pathlib import Path
import pandas as pd

DATA_DIR = Path(__file__).resolve().parents[1] / "data"
results = pd.read_csv(DATA_DIR / "results.csv")
constructors = pd.read_csv(DATA_DIR / "constructors.csv")

Copilot AI requested a review from NN-Coder July 14, 2026 18:17
@NN-Coder
NN-Coder marked this pull request as ready for review July 14, 2026 18:19
@NN-Coder
NN-Coder merged commit 96c9598 into main Jul 14, 2026
1 check passed
@NN-Coder
NN-Coder deleted the copilot/update-project-file-structure branch July 14, 2026 18:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants