diff --git a/.github/ISSUE_TEMPLATE/setup-unity.md b/.github/ISSUE_TEMPLATE/setup-unity.md new file mode 100644 index 0000000..4ccb930 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/setup-unity.md @@ -0,0 +1,14 @@ +--- +name: Setup Unity for PixDash +about: Steps to install Unity and verify project opens in Unity Hub +--- + +## Unity Setup + +Steps: + +1. Install Unity Hub from https://unity.com/download +2. In Unity Hub → Installs → Add Editor → select **Unity 6.3 LTS (6000.3.2f1)** +3. Clone the PixDash repository and open it from Unity Hub → Projects → Add + +After completing the steps, open a new issue or submit a PR with a screenshot showing PixDash in Unity Hub with the Unity version visible. See `CONTRIBUTING.md` for exact PR and `contributors/` filename requirements. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..f3d41f9 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,18 @@ +# Pull Request Template + +Thank you for your contribution! For onboarding and setup PRs (Issue #27), please follow this template. + +## Description +- Brief description of the change. + +## Checklist +- [ ] I have claimed the corresponding issue before working on it. +- [ ] This PR contains only the `contributors/.txt` file for onboarding (if applicable). +- [ ] I have included a screenshot showing PixDash in Unity Hub with the Unity version visible. + +Attach screenshot (or include image link): + +-- +Preview image can be pasted below: + +![Unity Hub screenshot](link-or-attach-file) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..442ca98 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,45 @@ +# Contributing to PixDash + +Thanks for wanting to contribute! This document explains how to set up the project locally and how to submit the required verification for onboarding issues. + +## Required Unity Version +- Unity Hub +- Unity Editor: **6.3 LTS (6000.3.2f1)** + +Using a different Unity version may cause project errors. Install the correct version via Unity Hub before opening the project. + +## Quick Setup +1. Fork this repository and clone your fork: + + git clone https://github.com//PixDash.git + +2. Open Unity Hub → `Projects` → `Add` → select the cloned `PixDash` folder. +3. Do not create a new project — open the repository as-is. + +## Onboarding Issue (Unity Setup) +For the onboarding issue (see Issue #27), we require a screenshot proving you opened the project in Unity Hub with the correct Unity version visible. + +Steps to submit proof: +1. In Unity Hub, open `Projects` and ensure `PixDash` appears with `Unity 6.3 LTS (6000.3.2f1)`. +2. Take a screenshot that clearly shows the project name and Unity version. +3. Add the screenshot link or short description to a text file in the `contributors/` folder named exactly with your roll number (for example `24CS0160.txt`). If you don't already have a file in `contributors/`, create one using your roll number as filename. +4. Commit only your text file (do not commit Unity generated files) and open a Pull Request with the screenshot included in the PR description. + +Example content for `contributors/.txt`: + +``` +Name: Your Name +Roll: 24CS0160 +Unity: Unity 6.3 LTS (6000.3.2f1) +Proof: https://imgur.com/your-upload or GitHub PR screenshot +``` + +## PR Checklist +- [ ] Claim the issue in the repository before starting work +- [ ] Add only the intended `contributors/.txt` file for onboarding +- [ ] Include the Unity Hub screenshot in the PR description +- [ ] Keep changes focused to the issue scope + +If you need help, open a thread on the project's Discord or create an issue asking for guidance. + +Thank you — we look forward to your contributions!