Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (40 loc) · 2.22 KB

CONTRIBUTING.md

File metadata and controls

57 lines (40 loc) · 2.22 KB
Raw

Contributing to bertie-mc

These repositories are the custom mods behind the bertie modpack — a public NeoForge 1.21.1 pack. Most are small, single-purpose mods; a few are larger systems.

Before you open anything

  • Every repo here targets Minecraft 1.21.1 / NeoForge 21.1.217 only. Ports to other Minecraft versions or to Fabric are out of scope and will be closed.
  • Several mods are written for the pack and assume its mod list is present. They are not guaranteed to be useful standalone. Each README says which.

Reporting a bug

Open an issue using the Bug report or Crash report template. A report is only actionable with:

  • the mod version (from the jar filename or mods.toml),
  • the NeoForge version,
  • whether you are running the bertie pack or your own,
  • the full log — logs/latest.log or the crash report, as a gist or attachment, not a screenshot of a fragment.

"It crashed" without a log cannot be diagnosed and will be closed.

Pull requests

PRs are welcome but please open an issue first for anything beyond a typo or an obvious one-line fix — these mods are tightly coupled to the pack's design and a change that looks harmless can contradict a deliberate progression decision.

  • Keep the diff to one concern.
  • Match the surrounding code style; there is no formatter to run.
  • ./gradlew build must pass. CI runs it on every PR.
  • Do not commit third-party jars. libs/ is gitignored on purpose: compile dependencies are resolved from public mavens (Modrinth, NeoForged, Architectury, FTB).

Commit messages

Conventional Commits — feat:, fix:, docs:, ci:, chore:, refactor:. The scope is optional: fix(forge): ….

Releasing (maintainers)

  1. Bump mod_version in gradle.properties.
  2. Commit.
  3. Tag vX.Y.Z and push the tag.

release.yml builds the jar and attaches it to a GitHub Release. The pack consumes mods from those Releases — never from a hand-built local jar.

Licence

Mods that are entirely our own work are released into the public domain under The Unlicense. A few repos are ports of other people's mods and keep the upstream licence with attribution — check the LICENSE or UNLICENSE file in each repo before assuming.