Skip to content

Commit ff1d48a

Browse files
authored
Merge pull request #9 from Alexandrress/develop
chore: repository cleanup
2 parents bc981af + 2a5077b commit ff1d48a

7 files changed

Lines changed: 140 additions & 11 deletions

File tree

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
---
5+
6+
**Describe the bug**
7+
A clear and concise description of what the bug is.
8+
9+
**To Reproduce**
10+
Steps to reproduce the behavior:
11+
1. Open scene X
12+
2. Do Y
13+
3. See error
14+
15+
**Expected behavior**
16+
What you expected to happen.
17+
18+
**Environment (please complete the following information):**
19+
- Unity version: 2020.1.10f1
20+
- OS: (e.g. Windows 10, macOS 10.15)
21+
22+
**Additional context**
23+
Add any other context about the problem here.
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
---
5+
6+
**Is your feature request related to a problem? Please describe.**
7+
A clear and concise description of what the problem is. Ex: I'm always frustrated when [...]
8+
9+
**Describe the solution you'd like**
10+
A clear and concise description of what you want to happen.
11+
12+
**Describe alternatives you've considered**
13+
A clear and concise description of any alternative solutions or features you've considered.
14+
15+
**Additional context**
16+
Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<!-- Describe the change you are making -->
2+
3+
## Changes
4+
5+
- Summary of changes.
6+
7+
## Checklist
8+
9+
- [ ] My change follows the repository's contributing guidelines.
10+
- [ ] I have run the tests locally (Unity Test Runner).
11+
12+
## Notes
13+
14+
Add any additional notes for reviewers here.

CODE_OF_CONDUCT.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
Our Pledge
4+
5+
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.
6+
7+
Standards
8+
9+
Examples of behavior that contributes to a positive environment include:
10+
11+
- Using welcoming and inclusive language.
12+
- Being respectful of differing viewpoints and experiences.
13+
14+
Unacceptable behavior will not be tolerated. If you experience or witness unacceptable behavior, please open an issue or contact the maintainers.

CONTRIBUTING.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Contributing
2+
3+
Thanks for considering contributing! A few simple guidelines help maintain a smooth workflow.
4+
5+
How to contribute
6+
7+
1. Fork the repository and create a branch from `main` named `feature/your-topic` or `fix/issue-number`.
8+
2. Make small, focused commits with clear messages.
9+
3. Run the tests locally via the Unity Test Runner before opening a PR.
10+
4. Open a Pull Request describing the change, linking any related issue.
11+
12+
PR checklist
13+
14+
- [ ] Follows existing code style (C# conventions used in Unity projects).
15+
- [ ] No changes to runtime code that break existing behavior unless necessary and documented.
16+
- [ ] Tests added or updated for new behavior.
17+
- [ ] CI checks (if present) pass.
18+
19+
Code style
20+
21+
- Prefer clear, descriptive names for classes and methods.
22+
- Keep Unity-specific code (Editor-only) inside `#if UNITY_EDITOR` or `Editor` folders.
23+
24+
Reporting issues
25+
26+
Use the issue templates when creating bug reports or feature requests.

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Repository contributors
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,29 @@
1-
# Unity-Github-Action
2-
A repository to showcase github action with Unity. The Unity project is empty.
3-
Don't forget to change the Unity version in each .yml if you use my files !
1+
# unity-github-action
42

5-
This repository has three workflows :
6-
- "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. 🔑
7-
- "test.yml" which verifies for each push that your project run all of its unit tests right, and that the project can be built. ⚙
8-
- "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. 🔨
3+
This repository contains a minimal Unity project used as an example for GitHub Actions / CI workflows.
94

10-
Thanks to @webbertaken ( https://game.ci/ )
5+
Unity version
116

12-
Tutorials I used :
13-
https://isaacbroyles.com/gamedev/2020/07/04/unity-github-actions.html
14-
https://bearandhammer.net/2020/06/13/github-actions-unity-3d/
7+
- Editor: 2020.1.10f1
8+
9+
Contents
10+
11+
- `Assets/` — Scenes, scripts and tests.
12+
- `ProjectSettings/` — Unity project settings.
13+
14+
Getting started
15+
16+
1. Open this folder in Unity Editor 2020.1.10f1.
17+
2. Open `Assets/Scenes/SampleScene.unity` and press Play.
18+
19+
Running tests
20+
21+
Use Unity Test Runner (Window → General → Test Runner) to run the tests in `Assets/Tests`.
22+
23+
Contributing
24+
25+
See [CONTRIBUTING.md](CONTRIBUTING.md).
26+
27+
License
28+
29+
This project is licensed under the MIT License. See [LICENSE](LICENSE).

0 commit comments

Comments
 (0)