starred/f1-race-replay
1
0
Fork 0
mirror of https://github.com/IAmTomShaw/f1-race-replay.git synced 2026-05-09 08:25:56 +02:00
Code Issues 133 Projects Packages Wiki Activity

[PR #254] Add MIT License, CONTRIBUTING guide, issue templates & PR template #253

New issue
Open
opened 2026-05-07 00:19:24 +02:00 by BreizhHardware · 0 comments
BreizhHardware commented 2026-05-07 00:19:24 +02:00
Owner
Copy link

📋 Pull Request Information

Original PR: https://github.com/IAmTomShaw/f1-race-replay/pull/254
Author: @thegreatalxx
Created: 3/13/2026
Status: 🔄 Open

Base: main ← Head: main

📝 Commits (5)

📊 Changes

6 files changed (+441 additions, -0 deletions)

View changed files

➕ .github/bug_report.yml (+111 -0)
➕ .github/config.yml (+9 -0)
➕ .github/feature_request.yml (+77 -0)
➕ .github/pull_request_template.md (+52 -0)
➕ CONTRIBUTING.md (+171 -0)
➕ LICENSE (+21 -0)

📄 Description

Add MIT License, CONTRIBUTING guide, Issue Templates & PR Template

Summary

This PR adds community and open-source hygiene files to the repository that were missing from the original project. These files make it easier for contributors to engage with the project correctly and consistently.

What's been added

📄 MIT License (LICENSE)

Added a standard MIT License file to the repository root. The project was previously unlicensed, which creates ambiguity for anyone who wants to fork, use, or contribute to the code. The MIT License makes it explicit that the project is free and open for use, modification, and distribution with attribution.

🤝 CONTRIBUTING.md

A full contributing guide covering:

  • How to fork, branch, and submit a pull request
  • Development setup (virtual environment, pip install -r requirements.txt, CLI flags)
  • Project structure breakdown (src/, main.py, interfaces, GUI, lib)
  • Coding guidelines (PEP 8, docstrings, no stray print() statements)
  • Notes on the known leaderboard inaccuracy so contributors don't file duplicate bug reports
  • How to use the PitWallWindow base class for custom telemetry windows
  • How to sync with upstream changes via git remote add upstream

🐛 .github/ISSUE_TEMPLATE/bug_report.yml

A structured GitHub issue form for bug reports, including:

  • Description and steps to reproduce
  • Expected vs actual behaviour
  • Terminal output / error message field
  • Affected race, year, and session type
  • OS, Python version, and package version fields
  • Pre-submit checklist to reduce duplicate issues

🚀 .github/ISSUE_TEMPLATE/feature_request.yml

A structured GitHub issue form for feature requests, including:

  • Feature summary and problem statement
  • Proposed solution and alternatives considered
  • Feature category dropdown (Visualisation, Telemetry, New session type, etc.)
  • Option for contributor to flag if they want to build it themselves

⚙️ .github/ISSUE_TEMPLATE/config.yml

  • Disables blank (freeform) issues to guide users toward the correct template
  • Adds quick links to the roadmap and discussions tab

🔀 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md

A PR description template that prompts contributors to include:

  • What the PR does and which issue it closes
  • Type of change (bug fix, feature, refactor, docs, etc.)
  • How it was tested (year, round, session type, OS, Python version)
  • Screenshots or recordings for visual changes
  • Pre-submit checklist

Why this matters

The upstream project has 71+ open PRs and an active contributor community. Without contribution guidelines or issue templates, PRs and issues arrive in inconsistent formats, making triage harder. These files are a low-effort, high-value addition that benefits anyone contributing to any fork of this project.

Files changed

LICENSE
CONTRIBUTING.md
.github/
├── ISSUE_TEMPLATE/
│   ├── bug_report.yml
│   ├── feature_request.yml
│   └── config.yml
└── PULL_REQUEST_TEMPLATE/
    └── pull_request_template.md

Testing

No functional code was changed. All added files are documentation and GitHub configuration — no tests required.

Checklist

  • No functional code was modified
  • MIT License added and consistent with open-source use of FastF1, Arcade, and PySide6
  • Issue templates tested locally and render correctly as GitHub forms (.yml format)
  • PR template covers all fields reviewers typically ask for in this repo
  • Branch is up to date with main

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/IAmTomShaw/f1-race-replay/pull/254 **Author:** [@thegreatalxx](https://github.com/thegreatalxx) **Created:** 3/13/2026 **Status:** 🔄 Open **Base:** `main` ← **Head:** `main` --- ### 📝 Commits (5) - [`98114c0`](https://github.com/IAmTomShaw/f1-race-replay/commit/98114c0845b132aec38e5c8f0e2e05ecf9536083) Create LICENSE - [`47c596e`](https://github.com/IAmTomShaw/f1-race-replay/commit/47c596ed458eab17737b1c2511f6582260f48e12) Add files via upload - [`51c06d9`](https://github.com/IAmTomShaw/f1-race-replay/commit/51c06d9ec12df92631457fd800d044a26ca949c2) Create test - [`1f77c2a`](https://github.com/IAmTomShaw/f1-race-replay/commit/1f77c2a0a37492fcd4f45dafd61f3113712639d8) Add files via upload - [`b21f841`](https://github.com/IAmTomShaw/f1-race-replay/commit/b21f8417a9d5d5f88c8f142d039e8080762d4a0d) Delete .github/test ### 📊 Changes **6 files changed** (+441 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `.github/bug_report.yml` (+111 -0) ➕ `.github/config.yml` (+9 -0) ➕ `.github/feature_request.yml` (+77 -0) ➕ `.github/pull_request_template.md` (+52 -0) ➕ `CONTRIBUTING.md` (+171 -0) ➕ `LICENSE` (+21 -0) </details> ### 📄 Description # Add MIT License, CONTRIBUTING guide, Issue Templates & PR Template ## Summary This PR adds community and open-source hygiene files to the repository that were missing from the original project. These files make it easier for contributors to engage with the project correctly and consistently. --- ## What's been added ### 📄 MIT License (`LICENSE`) Added a standard MIT License file to the repository root. The project was previously unlicensed, which creates ambiguity for anyone who wants to fork, use, or contribute to the code. The MIT License makes it explicit that the project is free and open for use, modification, and distribution with attribution. --- ### 🤝 `CONTRIBUTING.md` A full contributing guide covering: - How to fork, branch, and submit a pull request - Development setup (virtual environment, `pip install -r requirements.txt`, CLI flags) - Project structure breakdown (`src/`, `main.py`, interfaces, GUI, lib) - Coding guidelines (PEP 8, docstrings, no stray `print()` statements) - Notes on the known leaderboard inaccuracy so contributors don't file duplicate bug reports - How to use the `PitWallWindow` base class for custom telemetry windows - How to sync with upstream changes via `git remote add upstream` --- ### 🐛 `.github/ISSUE_TEMPLATE/bug_report.yml` A structured GitHub issue form for bug reports, including: - Description and steps to reproduce - Expected vs actual behaviour - Terminal output / error message field - Affected race, year, and session type - OS, Python version, and package version fields - Pre-submit checklist to reduce duplicate issues --- ### 🚀 `.github/ISSUE_TEMPLATE/feature_request.yml` A structured GitHub issue form for feature requests, including: - Feature summary and problem statement - Proposed solution and alternatives considered - Feature category dropdown (Visualisation, Telemetry, New session type, etc.) - Option for contributor to flag if they want to build it themselves --- ### ⚙️ `.github/ISSUE_TEMPLATE/config.yml` - Disables blank (freeform) issues to guide users toward the correct template - Adds quick links to the roadmap and discussions tab --- ### 🔀 `.github/PULL_REQUEST_TEMPLATE/pull_request_template.md` A PR description template that prompts contributors to include: - What the PR does and which issue it closes - Type of change (bug fix, feature, refactor, docs, etc.) - How it was tested (year, round, session type, OS, Python version) - Screenshots or recordings for visual changes - Pre-submit checklist --- ## Why this matters The upstream project has 71+ open PRs and an active contributor community. Without contribution guidelines or issue templates, PRs and issues arrive in inconsistent formats, making triage harder. These files are a low-effort, high-value addition that benefits anyone contributing to any fork of this project. --- ## Files changed ``` LICENSE CONTRIBUTING.md .github/ ├── ISSUE_TEMPLATE/ │ ├── bug_report.yml │ ├── feature_request.yml │ └── config.yml └── PULL_REQUEST_TEMPLATE/ └── pull_request_template.md ``` --- ## Testing No functional code was changed. All added files are documentation and GitHub configuration — no tests required. --- ## Checklist - [x] No functional code was modified - [x] MIT License added and consistent with open-source use of FastF1, Arcade, and PySide6 - [x] Issue templates tested locally and render correctly as GitHub forms (`.yml` format) - [x] PR template covers all fields reviewers typically ask for in this repo - [x] Branch is up to date with `main` --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
dial-insight
driver-telemetry-pit-wall-window
pit-wall-telemetry-windows
telemetry-stream
organised-legend
158-race-replay-leaderboard-inaccurate
No results found.
Labels
Clear labels   
bug

   
enhancement

   
pull-request
Mirrored from GitHub Pull Request

No labels
bug
enhancement
pull-request
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/f1-race-replay#253
No description provided.