Skip to content

Latest commit

 

History

History
70 lines (43 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

70 lines (43 loc) · 2.29 KB

Welcome to the P2P Media Loader Contributing Guide

Thank you for investing your time in contributing to our project! We appreciate every pull request, issue report, and suggestion you make to help improve P2P Media Loader.

Table of Contents

Using GitHub Codespaces

The easiest way to contribute is to use GitHub Codespaces, which are already preconfigured in this repository.

  1. Fork the repository (optional if you don’t have write access).
  2. Create a Codespace from the repository (click the green “Code” button, then choose Codespaces).
  3. Once the Codespace is ready, open the integrated terminal.
  4. Run pnpm dev to start the development environment.

That’s it! All required dependencies and tools are pre-installed, so you can begin coding, testing, and debugging immediately.

Developing Locally

If you prefer to develop without Codespaces, follow these steps:

  1. Ensure you have pnpm installed globally if you haven’t already.

  2. Clone the repository:

    git clone https://github.com/Novage/p2p-media-loader.git

  3. Install dependencies for all workspace projects:

    pnpm i

  4. Start development mode:

    pnpm dev

Contributing Process

Please follow GitHub flow when collaborating on our project.

  1. Open an issue: If you find a bug or have a feature request, start by creating a new issue to discuss.

  2. Fork the repository (if you don’t have direct commit access).

  3. Create a new branch for your changes:

    git checkout -b feature/your-feature

  4. Make your changes and commit them with a descriptive message.

  5. Push your branch to GitHub:

    git push origin feature/your-feature

  6. Open a pull request: Go to the repository on GitHub, click the “Compare & pull request” button, and fill out the PR template. Describe your changes clearly so reviewers know what you did and why.

We’ll review your pull request, provide feedback, and merge your changes once everything looks good.