From 2a5077b99139279196029f251c786febd00f8413 Mon Sep 17 00:00:00 2001 From: Alexandrress Date: Sat, 14 Feb 2026 14:56:07 +0100 Subject: [PATCH] chore: repository cleanup --- .github/ISSUE_TEMPLATE/bug_report.md | 23 ++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 16 ++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 14 +++++++++ CODE_OF_CONDUCT.md | 14 +++++++++ CONTRIBUTING.md | 26 ++++++++++++++++ LICENSE | 21 +++++++++++++ README.md | 37 ++++++++++++++++------- 7 files changed, 140 insertions(+), 11 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..abb93ec --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,23 @@ +--- +name: Bug report +about: Create a report to help us improve +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Open scene X +2. Do Y +3. See error + +**Expected behavior** +What you expected to happen. + +**Environment (please complete the following information):** +- Unity version: 2020.1.10f1 +- OS: (e.g. Windows 10, macOS 10.15) + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..3410049 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,16 @@ +--- +name: Feature request +about: Suggest an idea for this project +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex: I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..e9ed7d2 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,14 @@ + + +## Changes + +- Summary of changes. + +## Checklist + +- [ ] My change follows the repository's contributing guidelines. +- [ ] I have run the tests locally (Unity Test Runner). + +## Notes + +Add any additional notes for reviewers here. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..cffe709 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,14 @@ +# Contributor Covenant Code of Conduct + +Our Pledge + +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project a harassment-free experience for everyone. + +Standards + +Examples of behavior that contributes to a positive environment include: + +- Using welcoming and inclusive language. +- Being respectful of differing viewpoints and experiences. + +Unacceptable behavior will not be tolerated. If you experience or witness unacceptable behavior, please open an issue or contact the maintainers. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e7c4c24 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,26 @@ +# Contributing + +Thanks for considering contributing! A few simple guidelines help maintain a smooth workflow. + +How to contribute + +1. Fork the repository and create a branch from `main` named `feature/your-topic` or `fix/issue-number`. +2. Make small, focused commits with clear messages. +3. Run the tests locally via the Unity Test Runner before opening a PR. +4. Open a Pull Request describing the change, linking any related issue. + +PR checklist + +- [ ] Follows existing code style (C# conventions used in Unity projects). +- [ ] No changes to runtime code that break existing behavior unless necessary and documented. +- [ ] Tests added or updated for new behavior. +- [ ] CI checks (if present) pass. + +Code style + +- Prefer clear, descriptive names for classes and methods. +- Keep Unity-specific code (Editor-only) inside `#if UNITY_EDITOR` or `Editor` folders. + +Reporting issues + +Use the issue templates when creating bug reports or feature requests. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..eba4598 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Repository contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 2de5424..4aad687 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,29 @@ -# Unity-Github-Action -A repository to showcase github action with Unity. The Unity project is empty. -Don't forget to change the Unity version in each .yml if you use my files ! +# unity-github-action -This repository has three workflows : -- "activation.yml" which needs to be executed at the start of your project to get your license and set the "UNITY_LICENSE" variable in github secret. 🔑 -- "test.yml" which verifies for each push that your project run all of its unit tests right, and that the project can be built. ⚙ -- "build.yml" which is executed when creating a new release, testing once again your Unity project, and then building it for Windowsx64, and attaching the .zip to your release. 🔨 +This repository contains a minimal Unity project used as an example for GitHub Actions / CI workflows. -Thanks to @webbertaken ( https://game.ci/ ) +Unity version -Tutorials I used : -https://isaacbroyles.com/gamedev/2020/07/04/unity-github-actions.html -https://bearandhammer.net/2020/06/13/github-actions-unity-3d/ +- Editor: 2020.1.10f1 + +Contents + +- `Assets/` — Scenes, scripts and tests. +- `ProjectSettings/` — Unity project settings. + +Getting started + +1. Open this folder in Unity Editor 2020.1.10f1. +2. Open `Assets/Scenes/SampleScene.unity` and press Play. + +Running tests + +Use Unity Test Runner (Window → General → Test Runner) to run the tests in `Assets/Tests`. + +Contributing + +See [CONTRIBUTING.md](CONTRIBUTING.md). + +License + +This project is licensed under the MIT License. See [LICENSE](LICENSE).