Skip to content

contributing.md

Latest commit

 

History

History
199 lines (142 loc) · 5.47 KB

contributing.md

File metadata and controls

199 lines (142 loc) · 5.47 KB

🏠 > IPTV Contribution

Contributing to IPTV Player Project

Thank you for considering contributing to Megacubo! Your help is essential to keeping the project alive and improving it for everyone.

There are many ways to contribute, whether you're a developer, translator, designer, or just a passionate user.

Contributing Code

Megacubo is an open-source project hosted on GitHub at github.com/EdenwareApps/megacubo.

Understanding the Codebase

Before contributing code, familiarize yourself with the project structure:

  • Internal Modules: Check out the Internal Modules Documentation to understand how the different components work together
  • Module Architecture: Each module is self-contained with its own documentation
  • Event-based Communication: Modules communicate through Node.js EventEmitter
  • Shared Configuration: Common settings managed through the config module

IPTV Development Requirements

To build IPTV player from source locally, you'll need:

  • Node.js (v14 or higher)
  • Git installed and configured
  • For builds: system dependencies and build instructions (see building.md)

Setup Development Environment

  1. Clone the repository:

    git clone https://github.com/EdenwareApps/Megacubo.git
cd Megacubo

  2. Install dependencies:

    npm install

  3. Prepare the project (compiles and bundles the code):

    npm run prepare

    See development setup for more details.

  4. Test your changes:

    npm start  # Starts app (automatically detects development or production mode based on the last build)

Build Commands

Optimized Builds (Recommended - Smaller size, premium protection):

npm run build:electron:linux    # Linux: AppImage, Snap, Flatpak (~84MB)
npm run build:electron:win      # Windows: NSIS, MSI (~84MB)
npm run build:electron:mac      # macOS: DMG (~84MB)
npm run build:electron:all      # All platforms

Traditional Builds (Includes all dependencies):

npm run build:electron:linux              # Linux installers (~1.3GB+)
npm run build:electron:win                # Windows installers (~1.3GB+)
npm run build:electron:mac                # macOS installers (~1.3GB+)

Steps to Contribute

  1. Fork the repository on GitHub.
  2. Clone your fork and set up the development environment (see above).
  3. Create a feature branch: 
    git checkout -b feature/your-feature-name
  4. Make your changes and test thoroughly.
  5. Build and test installers to ensure compatibility.
  6. Commit your changes with clear commit messages.
  7. Push to your fork and create a pull request.

Development Guidelines

  • Follow existing code style and conventions
  • Write clear commit messages in English
  • Update documentation if needed

Translating Megacubo

Help make Megacubo available in your language:

  1. Check existing translations in the www/nodejs/lang folder
  2. Create or update translation files
  3. Test the translation in the app
  4. Submit a pull request with your changes

Translation Guidelines

  • Use clear, natural language
  • Maintain consistency with existing translations
  • Test UI elements to ensure proper fit
  • Follow platform conventions for your language

Reporting Bugs

Found a bug? Help us fix it:

  1. Check existing issues to avoid duplicates
  2. Create a new issue with:
    • Clear description of the problem
    • Steps to reproduce
    • Expected vs actual behavior
    • System information (OS, version, etc.)
    • Screenshots if applicable

Bug Report Template

**Bug Description:**
[Clear description of the issue]

**Steps to Reproduce:**
1. [Step 1]
2. [Step 2]
3. [Step 3]

**Expected Behavior:**
[What should happen]

**Actual Behavior:**
[What actually happens]

**System Information:**
- OS: [Windows/macOS/Linux/Android]
- Version: [Megacubo version]
- Device: [Device specifications]

**Additional Information:**
[Screenshots, logs, etc.]

Feature Requests

Have an idea for a new feature?

  1. Search existing issues to avoid duplicates
  2. Create a feature request with:
    • Clear description of the feature
    • Use cases and benefits
    • Implementation suggestions (if any)
    • Priority level

Documentation

Help improve our documentation:

  • Fix typos and grammar errors
  • Add missing information
  • Improve clarity and organization
  • Translate documentation to other languages

Community Support

Help other users:

  • Answer questions on GitHub Discussions
  • Help with troubleshooting
  • Share your experiences and tips
  • Welcome new contributors

Code of Conduct

We are committed to providing a welcoming and inclusive environment:

  • Be respectful to all contributors
  • Use inclusive language
  • Be patient with newcomers
  • Focus on constructive feedback

Getting Help

Need help contributing?

  • Read the documentation thoroughly
  • Ask questions on GitHub Discussions
  • Email us at [email protected]
  • Contact maintainers for guidance

Every contribution, no matter how small, helps make Megacubo better for everyone. Thank you for your support!

Next: Legal Notice Previous: Support & Contact