fetchff/CONTRIBUTING.md

<div align="center"> <img src="./docs/logo.png" alt="logo" width="380"/>

# Contributing to fetchff

Thank you for your interest in contributing to the `fetchff` package! Your contributions help improve the library and make it better for everyone. This document outlines how to contribute to the project.

## Table of Contents

- [Getting Started](#getting-started)
- [Reporting Issues](#reporting-issues)
- [Feature Requests](#feature-requests)
- [Submitting Code Changes](#submitting-code-changes)
- [Code Style Guidelines](#code-style-guidelines)
- [Testing](#testing)
- [Documentation](#documentation)
- [Code of Conduct](#code-of-conduct)

## Getting Started

1. **Fork the Repository**: Click the "Fork" button on the top right of the repository page to create your copy of the repository.
2. **Clone Your Fork**: Clone your forked repository to your local machine using:
   ```bash
   git clone https://github.com/your-username/fetchff.git
   cd fetchff
   ```
3. **Install Dependencies**: Install the necessary dependencies for the project:
   ```bash
   npm install
   ```

## Reporting Issues

If you encounter any bugs or issues, please report them using the following steps:

1. Check the existing issues to see if your problem has already been reported.
2. If not, create a new issue and provide as much detail as possible, including:
   - A clear and descriptive title
   - Steps to reproduce the issue
   - Expected vs. actual behavior
   - Environment details (OS, Node.js version, etc.)

## Feature Requests

We welcome feature requests! If you have an idea for a new feature:

1. Check the existing issues to see if your feature has already been suggested.
2. If not, create a new issue with the following information:
   - A clear title and description of the feature
   - Use cases for the feature and why it's valuable

## Submitting Code Changes

To contribute code changes:

1. **Create a New Branch**: Always create a new branch for your feature or bug fix:
   ```bash
   git checkout -b my-feature-branch
   ```
2. **Make Your Changes**: Implement your changes and ensure they work as expected.
3. **Commit Your Changes**: Write clear and descriptive commit messages:
   ```bash
   git commit -m "Add feature: Description of the feature"
   ```
4. **Push to Your Fork**: Push your changes to your fork:
   ```bash
   git push origin my-feature-branch
   ```
5. **Open a Pull Request**: Go to the original repository and open a pull request. Provide a clear description of the changes you made and why they should be merged.

## Code Style Guidelines

Please follow these guidelines when contributing:

- Use consistent indentation (spaces vs. tabs).
- Write clear and concise code with meaningful variable names.
- Keep your code clean and well-structured.

## Testing

Before submitting your changes, ensure that all tests pass:

1. Run the test suite using:
   ```bash
   npm test
   ```
2. If you add new features, please include appropriate tests.

## Documentation

If you add new features or make significant changes, please update the documentation accordingly. Ensure that all new functionality is clearly explained.

## Code of Conduct

By participating in this project, you agree to abide by the [Code of Conduct](CODE_OF_CONDUCT.md). We expect all contributors to be respectful and considerate to others.

---

Thank you for your contributions! We appreciate your help in making `fetchff` better.