@candle-so/node/CONTRIBUTING.md

A library for interacting with the Candle API

# Contributing to @candle-so/node

We welcome contributions from the community! Whether it's bug fixes, new features, or improvements to the documentation, your help is appreciated. Please follow these guidelines to contribute to the project.

## How to Contribute

1. Fork the repository.

2. Clone your forked repository:

   ```sh
   git clone https://github.com/candle-so/candle-node.git
   cd candle-node
   ```

3. Install the dependencies:

   ```sh
   npm install
   ```

4. Create a new branch for your changes:

   ```sh
   git checkout -b my-feature-branch
   ```

5. Make your changes. Ensure your code follows the project's coding standards.

6. Test your changes thoroughly.

7. Commit your changes with a clear and descriptive commit message:

   ```sh
   git commit -m \"Add feature X\"
   ```

8. Push your changes to your forked repository:

   ```sh
   git push origin my-feature-branch
   ```

9. Create a pull request from your branch to the main repository.

## Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for details.

## Bug Reports

If you find a bug, please create an issue with as much detail as possible. Include steps to reproduce the issue, your environment, and any relevant log output.

## Feature Requests

Feature requests are welcome! If you have an idea for a new feature, please create an issue and describe the feature, why you think it would be useful, and any implementation suggestions you may have.

## Pull Requests

When submitting a pull request:

1. Ensure there are no merge conflicts.
2. Provide a clear description of the changes.
3. Reference any related issues in the pull request description.
4. Ensure your code passes existing tests and includes new tests for any new functionality.

Thank you for contributing to @candle-so/node!