Add MIT License, CONTRIBUTING guide, issue templates & PR template#254
Open
thegreatalxx wants to merge 5 commits into
Open
Add MIT License, CONTRIBUTING guide, issue templates & PR template#254thegreatalxx wants to merge 5 commits into
thegreatalxx wants to merge 5 commits into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.mdA full contributing guide covering:
pip install -r requirements.txt, CLI flags)src/,main.py, interfaces, GUI, lib)print()statements)PitWallWindowbase class for custom telemetry windowsgit remote add upstreamπ
.github/ISSUE_TEMPLATE/bug_report.ymlA structured GitHub issue form for bug reports, including:
π
.github/ISSUE_TEMPLATE/feature_request.ymlA structured GitHub issue form for feature requests, including:
βοΈ
.github/ISSUE_TEMPLATE/config.ymlπ
.github/PULL_REQUEST_TEMPLATE/pull_request_template.mdA PR description template that prompts contributors to include:
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
Testing
No functional code was changed. All added files are documentation and GitHub configuration β no tests required.
Checklist
.ymlformat)main