Initial commit

This commit is contained in:
zontreck 2025-03-20 10:39:07 -07:00 committed by GitHub
commit 94a0826131
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
28 changed files with 2444 additions and 0 deletions

26
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,26 @@
# How to Contribute
## General workflow
0. (External contributors only) Create a fork of the repository
1. Pull any changes from `main` to make sure you're up-to-date
2. Create a branch from `main`
* Give your branch a name that describes your change (e.g. add-scoreboard)
* Focus on one change per branch
3. Commit your changes
* Keep your commits small and focused
* Write descriptive commit messages in [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/) format
4. When you're ready, create a pull request to `main`
* Keep your PRs small (preferably <300 LOC)
* Format your title in [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/) format
* List any changes made in your description
* Link any issues that your pull request is related to as well
### Example:
```text
Create scoreboard for total points
ADDED - Scoreboard displayed in-game at game end
CHANGED - Updated `StorageManager` class to persist scoreboard data
```
After the pull request has been reviewed, approved, and passes all automated checks, it will be merged into main.