world-manager/CONTRIBUTING.md

31 lines
1.6 KiB
Markdown

# Contributing
Thanks for considering a contribution. This project is small and early, so keep changes focused and easy to review.
## Development
- Use Xcode to build the `World Manager for Minecraft` scheme.
- Run relevant tests before opening a pull request.
- Keep source headers in the existing SPDX format.
- Do not commit `DerivedData`, `xcuserdata`, local build products, personal signing files, or Minecraft world/pack content unless the file is clearly a small synthetic fixture.
- Avoid adding third-party dependencies unless they solve a clear project problem and their license is compatible with AGPL-3.0-or-later.
## Pull Requests
Each pull request should include:
- A short description of the behavior change.
- The build or test command you ran, with the result.
- Any known limitations or follow-up work.
- Screenshots for visible UI changes.
## AI-Assisted Contributions
AI tools are allowed, but the submitter is responsible for the contribution. Review generated code before submitting it, verify that you understand it, and make sure it does not include copied proprietary code, credentials, or unexplained large snippets from another project.
If AI assistance materially shaped a pull request, disclose that in the PR description. A short note such as "AI-assisted with OpenAI Codex; reviewed and tested by me" is enough.
## Trademarks and Minecraft Content
Minecraft, Mojang, and Microsoft names and assets are owned by their respective owners. Do not submit official Minecraft assets, copied marketplace content, user worlds that are not yours to share, or changes that imply this project is endorsed by Mojang or Microsoft.