Skip to content

Latest commit

 

History

History
121 lines (86 loc) · 3.53 KB

CONTRIBUTING.md

File metadata and controls

121 lines (86 loc) · 3.53 KB

Contributing to Proxy Cloud 🤝

Thank you for considering contributing to the Proxy Cloud! We appreciate your help in improving and expanding the project.

🌟 Welcome, Contributor!

Proxy Cloud is a community-driven open source project. Your contributions help make internet privacy accessible to everyone worldwide.

Why Contribute?

  • Privacy Advocacy: Help protect digital rights
  • Skill Development: Work with modern Flutter and VPN technologies
  • Community Impact: Your work affects thousands of users
  • Open Source Experience: Gain experience in collaborative development

💡 How Can I Contribute?

🐛 Reporting Bugs

Help us improve Proxy Cloud by reporting bugs effectively:

  • Use GitHub Issues: Create a new issue for each bug
  • Be Specific: Include detailed steps to reproduce
  • Provide Context: Device info, OS version, app version
  • Include Screenshots: Visual evidence when possible
  • Error Messages: Copy/paste exact error text
  • Label Appropriately: Add the bug label

💡 Suggesting Features

Enhance Proxy Cloud with your ideas:

  • Search First: Check existing issues to avoid duplicates
  • Clear Description: Explain what you want and why
  • User Benefit: How does this help users?
  • Technical Feasibility: Consider implementation complexity
  • Label as Enhancement: Add the enhancement label

💻 Contributing Code

Ready to code? Follow these steps for a smooth contribution:

  1. 🍴 Fork the Repo

    • Click the "Fork" button on GitHub
    • Create your own copy of the repository

  2. 📋 Clone Your Fork

    git clone https://github.com/your-username/ProxyCloud.git
cd ProxyCloud

  3. 🌿 Create a New Branch

    git checkout -b feature/YourFeatureName

  4. ✍️ Make Changes

    • Follow existing code style
    • Add comments for complex logic
    • Update documentation when needed
    • Keep changes focused and atomic

  5. ✅ Test Your Changes

    • Run existing tests
    • Test your feature manually
    • Ensure no regressions

  6. 💾 Commit and Push

    git add .
git commit -m "Add new feature: YourFeatureName"
git push origin feature/YourFeatureName

  7. 📤 Submit a Pull Request

    • Go to your fork on GitHub
    • Click "New Pull Request"
    • Target the master branch
    • Write a clear description

Code Standards

  • Flutter/Dart Style: Follow official style guides
  • Comments: Explain why, not what
  • Documentation: Update README when needed
  • Tests: Add tests for new functionality

📚 Improving Documentation

Help make Proxy Cloud easier to understand:

  • Proofreading: Check for typos and grammar
  • Clarity: Simplify complex explanations
  • Completeness: Add missing information
  • Translations: Help with multi-language support
  • Examples: Add usage examples
  • Submit via PR: All documentation changes through pull requests

🎉 Thank You for Contributing!

Your contributions make Proxy Cloud better for everyone. Together, we're building a more private internet.

Recognition

  • Contributors listed in GitHub
  • Featured in release notes
  • Community appreciation

Stay Connected

  • GitHub Discussions: Join development conversations
  • Issue Tracker: Follow progress on features/bugs
  • Release Notes: See your contributions in action

Hossein Pira Lead Developer, Proxy Cloud

GitHub