elevenlabs-node/docs/CONTRIBUTING.md

This is an open source Eleven Labs NodeJS package for converting text to speech using the Eleven Labs API

<!-- omit in toc -->
# Contributing to ElevenLabs-node

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
> - ⭐ Star the project
> - 🐤 Tweet about it
> - 📜 Refer this project in your project's readme
> - 🗣 Mention the project at local meetups and tell your friends/colleagues



## Code of Conduct

This project and everyone participating in it is governed by the
ElevenLabs-node [Code of Conduct](https://github.com/FelixWaweru/elevenlabs-nodeblob/main/docs/CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code.

## Making A Contribution

- Fork the ElevenLabs-Node repository. (https://github.com/FelixWaweru/elevenlabs-node/fork)
- Push your suggested changes to the `main` branch of your fork.
- Create a Pull Request into the `test` branch of the original ElevenLabs-Node repository.
- Describe the changes using the [Pull Request Template](#pull-request-template).
- Add the [original repository owner](https://github.com/FelixWaweru) as a reviewer.

## I Have a Question

> If you want to ask a question, we assume that you have read the available [Documentation](https://github.com/FelixWaweru/elevenlabs-node#readme).

Before you ask a question, it is best to search for existing [Issues](https://github.com/FelixWaweru/elevenlabs-node/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, we recommend the following:

- Open an [Issue](https://github.com/FelixWaweru/elevenlabs-node/issues/new).
- Provide as much context as you can about what you're running into.
- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.

We will then take care of the issue as soon as possible.

## Pull Request Template
Use the following template in your Pull Request description.
```markdown
# Description
Addition of unit tests built in Jest.

## Issue
- Addresses issue #5

## Changes:
- [x] Added Jest unit tests for all relevant functions.
```