Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
184 lines (139 loc) · 5.22 KB

CONTRIBUTING.md

File metadata and controls

184 lines (139 loc) · 5.22 KB

Contributing to Slime Rancher Offline Setup Assistant

🎮 Thank you for your interest in contributing to the Slime Rancher Offline Setup Assistant! We welcome contributions from the gaming community to help make Slime Rancher more accessible to offline players.

🚀 Quick Start

  1. Fork the repository
  2. Clone your fork locally
  3. Create a feature branch
  4. Make your changes
  5. Test thoroughly
  6. Submit a pull request

🎯 Ways to Contribute

🐛 Bug Reports

Found a setup issue or compatibility problem? Please help us fix it!

  • Use the Bug Report Template
  • Include your system specifications
  • Describe the Slime Rancher version
  • Add screenshots if possible

💡 Feature Requests

Have ideas for improving the setup assistant?

  • Use the Feature Request Template
  • Explain the gaming use case
  • Describe the expected behavior
  • Consider offline gameplay implications

🔧 Setup Improvements

Help improve the offline setup process:

  • Better compatibility with different Windows versions
  • Enhanced graphics configuration options
  • Improved save file management
  • Better performance optimization

📝 Documentation

Improve our guides and documentation:

  • Setup tutorials
  • Troubleshooting guides
  • Performance optimization tips
  • Compatibility notes

🛠️ Development Setup

Prerequisites

  • Windows 10/11 (primary platform)
  • Administrative privileges for testing
  • Slime Rancher game files for testing
  • Basic knowledge of Windows batch scripts

Local Development

# Clone your fork
git clone https://github.com/YOUR-USERNAME/slime-rancher-offline-setup-assistant
cd slime-rancher-offline-setup-assistant

# Create a feature branch
git checkout -b feature/your-feature-name

# Make your changes
# Test on clean Windows installation if possible

# Commit changes
git add .
git commit -m "feat: add your feature description"

# Push to your fork
git push origin feature/your-feature-name

🎮 Testing Guidelines

Test Environments

  • ✅ Windows 10 (recommended)
  • ✅ Windows 11 (recommended)
  • ⚠️ Windows 8.1 (limited support)
  • ❌ Windows 7 (not supported)

Test Scenarios

  1. Fresh Installation: Test on clean Windows installation
  2. Different Hardware: Various graphics cards and configurations
  3. Multiple Game Versions: Different Slime Rancher versions
  4. Save File Migration: Test save file management features

Performance Testing

  • Monitor memory usage during setup
  • Test startup time improvements
  • Verify offline functionality
  • Check compatibility with game mods

📋 Code Style

Batch Scripts

  • Use clear, descriptive variable names
  • Add comments for complex operations
  • Handle errors gracefully
  • Test on different Windows versions

Documentation

  • Use clear, gaming-focused language
  • Include screenshots for visual steps
  • Provide troubleshooting tips
  • Consider non-technical users

🔍 Pull Request Process

Before Submitting

  • Code follows style guidelines
  • Changes are tested on Windows 10/11
  • Documentation is updated
  • No sensitive information included
  • Commit messages follow conventional format

Pull Request Template

Use our PR Template and include:

  • Clear description of changes
  • Screenshots/GIFs for UI changes
  • Testing performed
  • Breaking changes (if any)
  • Gaming impact assessment

Review Process

  1. Automated checks must pass
  2. Community review by maintainers
  3. Testing on different configurations
  4. Merge after approval

🎯 Gaming-Specific Guidelines

Offline Focus

  • All features must work without internet connection
  • No telemetry or online requirements
  • Local file management preferred
  • Respect user privacy

Performance Considerations

  • Minimize system resource usage
  • Fast startup and setup times
  • Efficient file operations
  • Compatibility with older hardware

User Experience

  • Simple, intuitive interface
  • Clear progress indicators
  • Helpful error messages
  • Gaming-focused terminology

🏆 Recognition

Contributors Hall of Fame

All contributors are recognized in our README.md and releases!

Types of Recognition

  • 🌟 Setup Wizard - Major setup improvements
  • 🎮 Gaming Expert - Game-specific optimizations
  • 📚 Documentation Master - Documentation contributions
  • 🐛 Bug Hunter - Critical bug fixes
  • 💡 Feature Creator - New feature implementations

📞 Need Help?

Community Support

Useful Resources

📜 Code of Conduct

This project follows our Code of Conduct. By participating, you agree to uphold this code and help create a welcoming gaming community.

Thank you for helping make Slime Rancher more accessible to offline gamers! 🎮✨