Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (38 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

56 lines (38 loc) · 1.86 KB
Raw

Contributing to Pogly Standalone

First off, thank you for considering contributing to Pogly Standalone! It's people like you who make this project a great tool for streamers.

If you have any questions regarding development, feel free to join our Discord server!

How Can I Contribute?

Reporting Bugs

If you find a bug, please report it by opening an issue here. Include details such as:

  • A clear and descriptive title
  • Steps to reproduce the issue
  • Expected and actual behavior
  • Screenshots or code snippets, if applicable

Suggesting Features

We are always looking to improve Pogly Standalone. If you have a feature request, please check our existing issues and open a new one if needed. Describe:

  • The problem you’re trying to solve
  • Why it will be beneficial
  • Any potential implementation ideas

Submitting Changes

  1. Fork the repository and create your branch from most recent x.x.x-release.
  2. Ensure you have no changes in your local main branch.
  3. Make your changes.
  4. Write clear, concise commit messages.
  5. Push your branch to your forked repository.
  6. Open a Pull Request here with a detailed description of the changes.
  7. Make sure your Pull Request is directed to the most recent release branch.
  8. Add Dynrothe and/or Chippy as a reviewer.

Getting Started

You can find development documentation here.

Prerequisites

Make sure you have the following installed:

Setup

  1. Fork the repository.
  2. Clone your fork: 
    git clone https://github.com/your-username/pogly-standalone.git
  3. Run npm install.
  4. Run npm start