Thank you for your interest in contributing to Magmastream! We welcome contributions from everyone, whether you're fixing a typo, improving documentation, adding a new feature, or reporting a bug.

This document provides guidelines and steps for contributing to Magmastream. By following these guidelines, you help maintain the quality and consistency of the project.

- [Code of Conduct](#code-of-conduct)

- [Getting Started](#getting-started)

- [Development Workflow](#development-workflow)

- [Pull Request Process](#pull-request-process)

- [Coding Standards](#coding-standards)

- [Testing](#testing)

- [Documentation](#documentation)

- [Community](#community)

We expect all contributors to adhere to our Code of Conduct. Please read it before participating.

- Be respectful and inclusive

- Be patient and welcoming

- Be thoughtful

- Be collaborative

- When disagreeing, try to understand why

- Node.js (v16.x or higher)

- npm (v7.x or higher)

- A running [Lavalink](https://github.com/freyacodes/Lavalink) server for testing

1. Fork the repository on GitHub

2. Clone your fork locally:

```bash

git clone https://github.com/YOUR-USERNAME/magmastream.git

cd magmastream

```

3. Install dependencies:

```bash

npm install

```

4. Add the original repository as a remote:

```bash

git remote add upstream https://github.com/Magmastream-NPM/magmastream.git

```

1. Create a new branch for your feature/fix:

```bash

git checkout -b feature/your-feature-name

```

or

```bash

git checkout -b fix/issue-you-are-fixing

```

2. Make your changes

3. Run tests to ensure your changes don't break existing functionality:

```bash

npm test

```

4. Commit your changes with a descriptive message:

```bash

git commit -m "feat: add new audio filter functionality"

```

We follow [Conventional Commits](https://www.conventionalcommits.org/) for commit messages.

Also take a look at [this](https://www.freecodecamp.org/news/how-to-write-better-git-commit-messages/) tutorial for more information.

5. Push to your fork:

```bash

git push origin feature/your-feature-name

```

6. Create a Pull Request from your fork to the [dev](https://github.com/Magmastream-NPM/magmastream/tree/dev) branch

1. Ensure your PR addresses a specific issue. If an issue doesn't exist, create one first.

2. Update documentation if necessary.

3. Include tests for new features.

4. Make sure all tests pass.

5. Wait for code review and address any requested changes.

6. Once approved, a maintainer will merge your PR.

We follow a set of coding standards to maintain consistency across the codebase:

- Use ESLint for code linting

- Follow the existing code style

- Write clear, descriptive variable and function names

- Comment complex code sections

- Keep functions small and focused on a single task

- Use TypeScript for type safety

- Use proper typing instead of `any` wherever possible

- Make interfaces for complex objects

- Use enums for predefined values

- Leverage union types and generics when appropriate

All new features and bug fixes should include tests. We use Jest for testing.

- Unit tests for individual functions and methods

- Integration tests for API endpoints and complex interactions

- Make sure your tests are meaningful and cover edge cases

To run tests:

npm test

Good documentation is crucial for the project:

- Update the README.md if necessary

- Document all public methods and classes with JSDoc comments

- Include examples for non-trivial functionality

- Update the changelog for significant changes

Join our community to discuss development, get help, or chat:

- [Discord Server](https://discord.gg/wrydAnP3M6)

- [GitHub Discussions](https://github.com/Magmastream-NPM/magmastream/discussions)

If you're creating a plugin for Magmastream:

1. Use the official plugin template

2. Follow the plugin development guidelines

3. Make sure your plugin is well-documented

4. Include tests for your plugin functionality

Only maintainers can release new versions. The process is:

1. Update version in package.json

2. Update CHANGELOG.md

3. Create a GitHub release

4. Publish to npm

If you have any questions about contributing, please reach out on our Discord server or open an issue on GitHub.

Thank you for contributing to Magmastream!

<div align="center">

<p align="center">

<img src="https://capsule-render.vercel.app/api?type=waving&color=gradient&height=300&section=header&text=Magmastream&fontSize=90&fontAlignY=35&animation=twinkling&fontColor=gradient&desc=Next-Generation%20Lavalink%20Wrapper&descSize=25&descAlignY=60" />

</p>

[](https://www.npmjs.com/package/magmastream)

[](https://github.com/Magmastream-NPM/magmastream/stargazers)

[](https://www.npmjs.com/package/magmastream)

<br />

<img src="https://readme-typing-svg.herokuapp.com?font=Fira+Code&duration=3000&pause=1000&color=00DDB3&center=true&vCenter=true&width=435&lines=Powerful+Audio+Streaming;Optimized+for+Lavalink+v4;Feature-Rich+API;Seamless+Integration" />

<div align="center">

<h3>🎵 The Most Advanced Lavalink Wrapper for Node.js 🚀</h3>

<h4>Powering the next generation of Discord music bots</h4>

</div>

<br />

<div align="center">

<table>

<tr>

<td align="center">🎯 Simple API</td>

<td align="center">⚡ High Performance</td>

<td align="center">🛠️ Rich Features</td>

</tr>

<tr>

<td align="center">🔌 Plugin Support</td>

<td align="center">📊 Advanced Analytics</td>

<td align="center">🎚️ Audio Filters</td>

</tr>

</table>

</div>

<div align="center">

<a href="https://docs.magmastream.com">

<img src="https://img.shields.io/badge/Documentation-00DDB3?style=for-the-badge&logo=bookstack&logoColor=white" />

</a>

<a href="https://github.com/Magmastream-NPM/magmastream_basics_bot">

<img src="https://img.shields.io/badge/Example_Bot-5865F2?style=for-the-badge&logo=discord&logoColor=white" />

</a>

<a href="https://discord.gg/HV59Z3zEjt">

<img src="https://img.shields.io/badge/Support_Server-FF6B6B?style=for-the-badge&logo=discord&logoColor=white" />

</a>

</div>

<div align="center">

<table>

<tr>

<td align="center" width="33%">

<img src="https://img.shields.io/badge/Lava_Jukebox-FF6B6B?style=for-the-badge&logo=discord&logoColor=white" /><br />

_{by Abel Purnwasy}

</td>

<td align="center" width="33%">

<img src="https://img.shields.io/badge/Stal-00DDB3?style=for-the-badge&logo=discord&logoColor=white" /><br />

_{by memte}

</td>

<td align="center" width="33%">

<img src="https://img.shields.io/badge/Lunio-5865F2?style=for-the-badge&logo=discord&logoColor=white" /><br />

_{by vexi}

</td>

</tr>

</table>

[View All Projects →](https://github.com/Magmastream-NPM/magmastream#used-by)

</div>

</div>

| [Savage Bot](https://discord.com/oauth2/authorize?client_id=823703707522433054&permissions=8&scope=bot%20applications.commands) | Savage

| [rive](https://discord.com/oauth2/authorize?client_id=1350601402325405806) | pomice

<td align="center" valign="top" width="14.28%">

<a href="https://discord.gg/JCaTDJRz7P">

<img src="https://avatars.githubusercontent.com/u/58607083?v=4?s=100" width="100px;" alt="Darek"/>

<br />

_<b>Darek</b>

</a>

<br />

<a href="#doc-realdarek" title="Documentation">📖</a>

</td>

<td align="center" valign="top" width="14.28%">

<a href="https://github.com/Vexify4103">

<img src="https://avatars.githubusercontent.com/u/47192617?v=4?s=100" width="100px;" alt="Vexify4103"/>

<br />

_{<b>Vexify4103</b>}

</a>

<br />

<a href="#code-Vexify4103" title="Code">💻</a>

<a href="#doc-Vexify4103" title="Documentation">📖</a>

</td>

<td align="center" valign="top" width="14.28%">

<a href="https://github.com/ItzRandom23">

<img src="https://avatars.githubusercontent.com/u/100831398?v=4?s=100" width="100px;" alt="Itz Random"/>

<br />

_{<b>Itz Random</b>}

</a>

<br />

<a href="#code-ItzRandom23" title="Code">💻</a>

</td>

<br />

<img src="https://contributers.code-fy.tech/Magmastream-NPM?yousuck" alt="Contributors" />

</div>

We welcome contributions! Check out our [Contributing Guide](CONTRIBUTING.md) to get started.

[](CONTRIBUTING.md)

</div>

<div align="center">

<br />

<p align="center">

<img src="https://capsule-render.vercel.app/api?type=waving&color=gradient&height=100&section=footer" />

</p>

_{Built with ❤️ by the Magmastream Team}

</div>

"version": "2.8.6",

}