This repository has been archived by the owner on May 13, 2023. It is now read-only.

Contributing

Preferred conventions and code style

For commiting, we encourage Conventional Commits.
We encourage access modifiers to be specified explicitly with no exceptions.
Keep access modifiers as strict as possible (E.G: Do not default everything to public when they're not meant for public access).
Unity messages (Awake, Start, Update etc..) should always be private.
Remove unused using statements. Many IDEs offer shortcuts to perform this action.
For namespaces, use File Scoped Namespaces.

Setup

Download and install .NET 7
Fork & clone the repository
Open the solution (.sln) file with your favorite IDE
Restore the dependencies by performing a NuGet restore via your IDE or by simply executing dotnet restore in a terminal
Make your changes, then submit a pull request.

Submitting a Pull Request

We expect submitted PRs to be functional and thoroughly tested in the game. Please make sure of the following:

Your changes do not break existing mods. Be it in a new world/save, or existing ones
Follow our Pull Request Template
Run code refactoring automations to match our preferred styles.

If you are new to pull requests, read through GitHub's Guide.

Docs Contribution

If you're looking to contribute to the docs, refer to our Docs Guidelines.