Pull Request Descriptions

Sol uses the repository PR template in .github/PULL_REQUEST_TEMPLATE.md. Fill every section that applies — reviewers rely on it.

Template overview

Example filled PR description

Short description

What does this PR change? Keep it concrete.

Why we need to add this

Motivation, links to discussions / issues / bug reports, and balance impact when relevant.

Media

In-game changes need screenshots or video. Pure docs/refactors can note that no media is required.

Checks

Confirm each box you can honestly tick:

  • You do not need hand-holding to finish the PR.
  • You verified the change works before requesting review.
  • You attached media or the PR does not change in-game mechanics.
  • You affirm the contribution is under the MIT License for this repository.

Changelog

If players should see the change, add a :cl: block outside HTML comments:

:cl: SOL TEAM
- add: Added something useful.
- remove: Removed a broken feature.
- tweak: Adjusted a value or system.
- fix: Fixed a bug.

Omit the changelog when the change is invisible to players (infra, docs-only, etc.).