Skip to content
This repository was archived by the owner on Sep 21, 2026. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
79 lines (58 loc) · 3.17 KB

CONTRIBUTING.md

File metadata and controls

79 lines (58 loc) · 3.17 KB
Raw

⚠️ ARCHIVED / MOVED

This repository (runtoolkit/suite) is archived and no longer maintained.

All further development continues at: https://github.com/vortacraftmc/core

Please open issues, PRs, and use the latest releases from the new repository. This repo is kept only as a historical snapshot.

Contributing to runtoolkit/suite (ARCHIVED)

Thanks for your interest in contributing to this project.

Read NOTICE.md before opening a PR. It covers the Gradle/datapack split in this monorepo (what's built by buildAll and what isn't), what a PR should contain, and what will get a PR closed (obfuscated code, undisclosed behavior, misuse of the macro/command tooling for griefing or exploit purposes). This guide assumes you've already read it.

Getting started

  1. Fork or clone the repository.

  2. Create a branch for your change:

    git checkout -b your-branch-name

  3. Make your changes.

  4. Build and lint before opening a PR:

    ./gradlew buildAll
./gradlew lint

Branch naming

No strict convention is enforced. Use a branch name that describes the change (e.g. fix-gui-crash, add-slot-source-support).

Commit messages

Keep commit messages short and descriptive. Reference related issues or PRs where relevant.

Pull requests

  • Open a PR against the main branch.
  • Make sure Build all subprojects and Lint all subprojects pass in CI before requesting review.
  • Describe what changed and why in the PR description — and whether the change touches mods/, packs/, or both, since only the former is covered by buildAll.
  • Run through the checklist at the bottom of NOTICE.md before requesting review.

Security

This project follows a security-first development philosophy, particularly around Minecraft datapack macro injection risks and namespace isolation. If you find a security issue, avoid opening a public issue — contact a maintainer directly instead.

Provenance watermark (_rt_origin.mcfunction)

Every datapack under packs/ carries a _rt_origin.mcfunction file (under data/<namespace>/function/) that build.gradle's zipPacks task checks for before packaging. This file is not build output and should not be removed, renamed, or hand-edited in packs/ by a contributor's PR — zipPacks treats a missing watermark as a build failure, and the project maintainers ask that it stay untouched in the source tree. Only build.gradle itself (via its build/packs-remap/ working copy, never packs/) and maintainers acting through the project's own tooling are expected to touch these files. This is a contribution-conduct expectation, not a license restriction — the Unlicense in LICENSE continues to govern (this repo is archived; see vortacraftmc/core) what anyone may do with a copy of this code once obtained.

Code style

  • Java code should be clear and documented; complex logic should include comments explaining intent.
  • Avoid introducing unnecessary dependencies.
  • Fabric mod code must remain tick-safe (see project TPS guidelines).

Questions

Open an issue if something in this guide is unclear or if you need help getting your environment set up.