Skip to content

PULL_REQUEST_TEMPLATE.md

Latest commit

 

History

History
182 lines (147 loc) · 5.04 KB

PULL_REQUEST_TEMPLATE.md

File metadata and controls

182 lines (147 loc) · 5.04 KB

Pull Request

📋 Description

Brief description of the changes:

🎯 Type of Change

What type of change does this PR introduce?

  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to change)
  • 📚 Documentation update
  • 🎨 Code style/formatting changes
  • ♻️ Refactoring (no functional changes)
  • ⚡ Performance improvements
  • 🔒 Security improvements
  • 🧪 Tests (adding or updating tests)
  • 🔧 Build/CI configuration changes

🎮 Gaming Impact

How does this change affect the Slime Rancher gaming experience?

  • Improves game performance
  • Fixes game crashes or errors
  • Enhances graphics/display quality
  • Improves audio experience
  • Better controller support
  • Enhanced save file management
  • Offline gaming improvements
  • Setup process improvements
  • No direct gaming impact
  • Other: _________________

🔗 Related Issues

Link any related issues:

  • Fixes #
  • Relates to #
  • Part of #

🧪 Testing Performed

Describe the testing you've done:

Test Environments

  • Windows 10 (version: _______)
  • Windows 11 (version: _______)
  • Fresh Windows installation
  • Existing game installation
  • Different hardware configurations

Test Scenarios

  • Setup wizard functionality
  • Game launches successfully
  • Save files work correctly
  • Graphics settings apply properly
  • Audio configuration works
  • Controller detection/setup
  • Performance is acceptable
  • Error handling works
  • Edge cases tested

Specific Tests

Detail any specific tests performed: 1. 2. 3.

📸 Screenshots/GIFs

If applicable, add screenshots or GIFs showing the changes:

Before

After

📋 Checklist

Please check all applicable items:

Code Quality

  • My code follows the project's style guidelines
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings or errors
  • I have added error handling where appropriate

Testing

  • I have tested my changes on Windows 10 and/or 11
  • I have tested the complete setup process
  • I have verified game functionality after setup
  • I have tested edge cases and error conditions
  • My changes don't break existing functionality

Documentation

  • I have updated relevant documentation
  • I have added/updated code comments
  • I have updated the CHANGELOG.md (if applicable)
  • My commit messages are clear and descriptive

Security & Privacy

  • My changes don't introduce security vulnerabilities
  • I haven't included any personal information or credentials
  • My changes maintain offline-first functionality
  • I haven't added any telemetry or tracking

💡 Implementation Details

Technical details about your implementation:

Architecture Changes

Any changes to the overall architecture:

New Dependencies

Any new dependencies added:

  • Dependency: _______ (Reason: _______)
  • Dependency: _______ (Reason: _______)

Performance Considerations

Performance impact of your changes:

  • No performance impact
  • Improves performance
  • Minor performance decrease (justified by: _______)
  • Significant performance impact (requires review)

🔄 Migration Guide

If this is a breaking change, provide migration instructions:

📚 Documentation Updates

What documentation needs to be updated?

  • README.md
  • User guides
  • Technical documentation
  • Code comments
  • API documentation
  • FAQ
  • No documentation changes needed

🎯 Future Considerations

Any future work this enables or blocks:

💬 Additional Notes

Anything else reviewers should know:

🔍 For Reviewers

Areas that need special attention:

  • Security implications
  • Performance impact
  • Gaming functionality
  • Error handling
  • Cross-platform compatibility
  • User experience
  • Code maintainability

✅ Definition of Done

This PR is ready to merge when:

  • All checks pass
  • Code review approved
  • Testing completed on target platforms
  • Documentation updated
  • No merge conflicts
  • Gaming functionality verified

🏷️ PR Labels (for maintainers)

  • bug - Bug fixes
  • enhancement - New features
  • documentation - Documentation updates
  • performance - Performance improvements
  • security - Security related
  • breaking-change - Breaking changes
  • needs-testing - Requires additional testing
  • ready-for-review - Ready for code review
  • work-in-progress - Still being developed
  • priority-high - High priority changes
  • priority-medium - Medium priority
  • priority-low - Low priority

Thank you for contributing to the Slime Rancher gaming community! 🎮✨