Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (36 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

53 lines (36 loc) · 1.73 KB

Contributing to StreamLink

Thank you for your interest in contributing to StreamLink! We welcome contributions from the community to help improve this tool for streamers everywhere.

🤝 Code of Conduct

By participating in this project, you are expected to uphold a respectful and inclusive environment for everyone.

🚀 How to Contribute

Reporting Bugs

  1. Check the Issues tab to ensure the bug hasn't already been reported.
  2. Open a new issue with a clear title and detailed description.
  3. Include steps to reproduce, expected behavior, and screenshots if applicable.

Suggesting Features

  1. Open a new issue with the "Enhancement" label.
  2. Describe the feature you'd like to see and why it would be useful.

Submitting Pull Requests

  1. Fork the repository and create your branch from main.
  2. Install dependencies: 
    npm install
  3. Make your changes. Ensure your code follows the existing style and conventions.
  4. Test your changes: 
    npm run electron:dev
  5. Submit a Pull Request (PR) to the main branch.
  6. Provide a clear description of your changes and reference any related issues.

💻 Development Setup

  • Node.js: Ensure you have Node.js installed (LTS version recommended).
  • Package Manager: We use npm.

📜 License & Usage

StreamLink is Open Source for Non-Commercial Use. By contributing, you agree that your contributions will be licensed under the project's LICENSE.

Strictly Prohibited:

  • Selling this software or its derivatives.
  • Redistributing for profit.
  • Commercial exploitation of the codebase.

Thank you for helping make StreamLink better!