Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
169 lines (128 loc) · 5.7 KB

CONTRIBUTING.md

File metadata and controls

169 lines (128 loc) · 5.7 KB

🤝 Contributing to Thank Goodness You're Here! Offline Setup Assistant

First off, thank you for considering contributing to our project! It's people like you that make the offline gaming community so great.

🎯 Ways to Contribute

🐛 Bug Reports

Found a bug? We want to hear about it! When filing an issue, make sure to answer these five questions:

  1. What operating system and processor architecture are you using?
  2. What version of the setup assistant are you running?
  3. What did you do?
  4. What did you expect to see?
  5. What did you see instead?

💡 Feature Requests

Got an idea for a new feature? We love feature requests! Please provide:

  • Use case: Why would this feature be useful?
  • Description: What should this feature do?
  • Examples: Any examples of similar features elsewhere?

🔧 Code Contributions

We welcome code contributions! Here's how to get started:

Development Setup

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/your-username/thank-goodness-youre-here-offline-setup-assistant.git
  3. Create a feature branch: git checkout -b feature/your-feature-name
  4. Make your changes
  5. Test thoroughly on multiple platforms
  6. Commit your changes: git commit -am 'Add some feature'
  7. Push to the branch: git push origin feature/your-feature-name
  8. Submit a pull request

Code Style Guidelines

  • Use clear, descriptive variable and function names
  • Comment complex logic
  • Follow platform-specific best practices
  • Include error handling
  • Test on Windows, macOS, and Linux where applicable

📝 Documentation

Help improve our documentation by:

  • Fixing typos or unclear instructions
  • Adding examples and use cases
  • Translating content to other languages
  • Creating video tutorials or guides

🌍 Translations

We welcome translations for:

  • README files in different languages
  • Setup assistant interface text
  • Error messages and user notifications
  • Documentation and guides

Currently supported languages:

  • English (native)
  • Spanish, French, German, Italian, Russian, Japanese, Korean (in progress)

🎨 Community Content

Share your contributions with the community:

  • Screenshots from different platforms
  • Video tutorials showing installation process
  • Troubleshooting guides for specific issues
  • Performance optimization tips

📋 Pull Request Process

  1. Update documentation if you're changing functionality

  2. Test on multiple platforms when possible

  3. Follow our commit message format:

    type(scope): brief description

Longer description if needed

Fixes #issue-number

    Types: feat, fix, docs, style, refactor, test, chore

  4. Link related issues in your PR description

  5. Be responsive to code review feedback

🎮 Gaming-Specific Guidelines

Game Compatibility

When working on compatibility features:

  • Test thoroughly before submitting
  • Document system requirements for new features
  • Consider different game versions and platforms
  • Preserve game integrity - don't modify core game files

Performance Considerations

  • Optimize for different hardware configurations
  • Minimize resource usage during installation
  • Provide options for different quality settings
  • Test on low-end hardware when possible

User Experience

  • Keep installation simple and straightforward
  • Provide clear error messages and solutions
  • Support offline usage completely
  • Make it accessible to non-technical users

🚫 What We Don't Accept

  • Piracy or illegal content - We support game preservation, not piracy
  • Malicious code - All contributions are reviewed for security
  • Breaking changes without discussion
  • Incomplete features - Please finish features before submitting
  • Code without tests for critical functionality

🏆 Recognition

Contributors will be recognized in:

  • README file contributors section
  • Release notes for significant contributions
  • Special badges for frequent contributors
  • Community highlights on our social media

Types of Recognition

  • 🌟 Code Contributors: For code improvements and new features
  • 📝 Documentation Heroes: For improving docs and guides
  • 🌍 Translation Masters: For localization efforts
  • 🐛 Bug Hunters: For finding and reporting issues
  • 🎨 Community Artists: For visual and creative contributions

💬 Getting Help

Need help contributing? Reach out to us:

📜 Code of Conduct

This project follows our Code of Conduct. By participating, you agree to uphold this code. Please report unacceptable behavior to community@thank-goodness-offline.com.

🎯 Current Priorities

Help us with these high-priority items:

Immediate Needs

  • macOS compatibility improvements
  • Linux distribution testing
  • Controller support enhancements
  • Error handling improvements

Upcoming Features

  • Auto-updater for the setup assistant
  • Multiple language interface support
  • Save game backup utility
  • Mod support integration

Long-term Goals

  • Steam Deck optimization
  • Mobile platform support
  • Cloud save backup options
  • Community mod sharing platform

Thank you for contributing to making gaming more accessible and preserving digital entertainment for everyone! 🎮

"Thank goodness you're here to help!" 🤪