Skip to content

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

Open
thegreatalxx wants to merge 5 commits into
IAmTomShaw:mainfrom
thegreatalxx:main
Open

Add MIT License, CONTRIBUTING guide, issue templates & PR template#254
thegreatalxx wants to merge 5 commits into
IAmTomShaw:mainfrom
thegreatalxx:main

Conversation

@thegreatalxx

Copy link
Copy Markdown

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

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.

1 participant