Initial Minecraft Renew Mod workspace
This commit is contained in:
53
CONTRIBUTING.md
Normal file
53
CONTRIBUTING.md
Normal file
@@ -0,0 +1,53 @@
|
||||
# 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:
|
||||
|
||||
```powershell
|
||||
.\gradlew build
|
||||
```
|
||||
|
||||
For dependency review, run:
|
||||
|
||||
```powershell
|
||||
.\gradlew dependencies --configuration runtimeClasspath
|
||||
```
|
||||
|
||||
If this workspace is a Git repository, also run from the root:
|
||||
|
||||
```powershell
|
||||
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:
|
||||
|
||||
```text
|
||||
CHANGELOG.md
|
||||
docs/release-checklist.md
|
||||
docs/security-review.md
|
||||
README.md
|
||||
```
|
||||
|
||||
Release only after explicit approval.
|
||||
Reference in New Issue
Block a user