Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
189 lines (152 loc) · 5.26 KB

CONTRIBUTING.md

File metadata and controls

189 lines (152 loc) · 5.26 KB
Raw

Contributing to FFVII Rebirth Offline Setup Assistant

Thank you for considering contributing to our project! 🎮 This document provides guidelines for contributing to the FFVII Rebirth Offline Setup Assistant.

🌟 Ways to Contribute

🐛 Reporting Bugs

  • Use the GitHub issue tracker
  • Check if the issue already exists
  • Provide detailed information about the bug
  • Include system specifications and steps to reproduce

💡 Suggesting Features

  • Open a feature request issue
  • Describe the feature and its benefits
  • Discuss implementation approaches
  • Consider backwards compatibility

🌍 Translations

  • Help localize the setup assistant
  • Currently supporting: English, Japanese, French, German, Spanish, Italian, Portuguese, Russian, Chinese, Korean
  • Translation files are located in /locales/

📝 Documentation

  • Improve existing documentation
  • Add new guides and tutorials
  • Fix typos and grammatical errors
  • Update outdated information

🔧 Code Contributions

  • Fix bugs and implement features
  • Improve performance and stability
  • Add new functionality
  • Enhance user experience

🚀 Getting Started

Prerequisites

  • Git installed on your system
  • Basic knowledge of the technologies used (Python, JavaScript, etc.)
  • Familiarity with the Final Fantasy VII Rebirth game

Setting Up Development Environment

  1. Fork the repository
  2. Clone your fork locally: 
    git clone https://github.com/yourusername/final-fantasy-vii-rebirth-offline-setup-assistant.git
cd final-fantasy-vii-rebirth-offline-setup-assistant
  3. Create a new branch: 
    git checkout -b feature/your-feature-name
  4. Make your changes
  5. Test thoroughly
  6. Commit your changes
  7. Push to your fork
  8. Create a pull request

📋 Pull Request Guidelines

Before Submitting

  • Code follows the project's coding standards
  • Tests pass (if applicable)
  • Documentation is updated
  • Commit messages are descriptive
  • No merge conflicts

Pull Request Template

## Description
Brief description of the changes

## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Documentation update
- [ ] Performance improvement
- [ ] Other (please describe)

## Testing
- [ ] I have tested these changes
- [ ] All existing tests pass
- [ ] I have added tests for new functionality

## Screenshots (if applicable)
Add screenshots to help explain your changes

## Checklist
- [ ] My code follows the project's style guidelines
- [ ] I have performed a self-review of my code
- [ ] I have commented my code where necessary
- [ ] My changes generate no new warnings

🎯 Code Style Guidelines

General Principles

  • Write clean, readable code
  • Use meaningful variable and function names
  • Keep functions small and focused
  • Comment complex logic
  • Follow existing code patterns

Commit Messages

  • Use present tense ("Add feature" not "Added feature")
  • Use imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally

Examples:

feat: add multi-language support for setup wizard
fix: resolve memory leak in configuration parser
docs: update installation guide with new screenshots
style: improve button styling in main interface

🛡️ Security

Reporting Security Issues

  • Do not open public issues for security vulnerabilities
  • Email security concerns to: security@ff7rebirth-offline.com
  • Include detailed information about the vulnerability
  • Allow time for the issue to be addressed before public disclosure

Security Guidelines

  • Never commit sensitive information (passwords, tokens, etc.)
  • Use secure coding practices
  • Validate all user inputs
  • Keep dependencies updated

📞 Community Guidelines

Be Respectful

  • Treat everyone with respect and kindness
  • Be patient with newcomers
  • Provide constructive feedback
  • Avoid discriminatory language

Communication Channels

  • GitHub Issues: Bug reports and feature requests
  • GitHub Discussions: General questions and community chat
  • Discord: Real-time community interaction
  • Email: Security issues and private matters

🏆 Recognition

Contributors

All contributors will be recognized in:

  • The project's README.md
  • Release notes
  • Hall of Fame on our website
  • Special Discord roles

Types of Contributions Recognized

  • Code contributions
  • Documentation improvements
  • Bug reports
  • Feature suggestions
  • Translations
  • Community support
  • Testing and feedback

📚 Resources

Documentation

External Resources

❓ Questions?

If you have questions about contributing:

  1. Check the existing documentation
  2. Search through existing issues
  3. Ask in GitHub Discussions
  4. Join our Discord community
  5. Email us at: contribute@ff7rebirth-offline.com

Thank you for contributing to the FFVII Rebirth Offline Setup Assistant! Together, we're making offline gaming more accessible for everyone. 🌟