Pull Request Guidelines
Pull Request Guidelines
Section titled “Pull Request Guidelines”Before You Start
Section titled “Before You Start”- Check open issues to avoid duplicate work
- For large features, open an issue first to discuss the approach
- Fork the repository and work on a feature branch
Branch Naming
Section titled “Branch Naming”feature/short-descriptionfix/bug-descriptiondocs/what-you-documentedrefactor/what-you-refactoredCode Quality
Section titled “Code Quality”go fmtyour code before submittinggo vet ./...should pass without errors- Add tests for new functionality in
pkg/ - Keep changes focused — one PR per feature/fix
Commit Messages
Section titled “Commit Messages”Write clear, present-tense commit messages:
Add poison resistance status effect
- Implements PoisonResist status that reduces DoT damage by 50%- Adds resistance to EnemyTrait for configuring immune enemies- Updates combat resolver to check resistance before applying DoTPR Description Template
Section titled “PR Description Template”## What this PR doesBrief description of the change.
## WhyWhy is this change needed? Link to the relevant issue.
## How to testSteps to verify the change works correctly.
## Screenshots (if UI changes)Running Tests
Section titled “Running Tests”go test ./...Checklist
Section titled “Checklist”- Code is
gofmt-formatted -
go vet ./...passes - Tests pass
- New functionality has tests
- Documentation updated (if applicable)
What Gets Merged
Section titled “What Gets Merged”TalesMUD merges contributions that:
- Fix real bugs
- Add features from the roadmap
- Improve test coverage
- Improve documentation accuracy
PRs that introduce breaking changes without discussion will be held for review.