Files
minecraft-renew-mod/CONTRIBUTING.md
ToxicCrzay270 5e6a3e0450
Some checks failed
Build / build (push) Successful in 6m29s
Release Dry Run / release-dry-run (push) Failing after 11s
Codex Template Compliance / template-compliance (push) Successful in 4s
Initial Minecraft Renew Mod workspace
2026-05-15 00:42:16 +02:00

1.1 KiB

Contributing

Working Rules

  • Keep changes scoped to the issue or user request.
  • Prefer the existing Gradle, NeoForge, and Create mod patterns.
  • Do not commit secrets, generated credentials, local .env files, private keys, local Minecraft worlds, run logs, or build outputs.
  • Do not create releases unless explicitly requested.
  • Preserve unrelated user changes.

Before Committing

From create-limited-draining/, run:

.\gradlew build

For dependency review, run:

.\gradlew dependencies --configuration runtimeClasspath

If this workspace is a Git repository, also run from the root:

git diff --check

If a command cannot run, document why in the final response or handoff notes.

Pull Requests

Pull requests should include:

  • summary of changes,
  • verification performed,
  • known risks or skipped checks,
  • artifact/download notes when relevant.

Releases

Before release work, update:

CHANGELOG.md
docs/release-checklist.md
docs/security-review.md
README.md

Release only after explicit approval.