@nodeflip/nest-axios-http/CONTRIBUTING.md

A NestJS module for simplified HTTP requests using Axios with dynamic configuration, logging, and interceptor support.

# Contributing to `@nodeflip/nest-axios-http`

Welcome to `@nodeflip/nest-axios-http`! We're excited that you're interested in contributing. This guide outlines how you can get involved and contribute to our project.

## Table of Contents

- [Code of Conduct](#code-of-conduct)
- [Reporting Issues](#reporting-issues)
- [Feature Requests](#feature-requests)
- [Contributing Code](#contributing-code)
  - [Setting Up Your Development Environment](#setting-up-your-development-environment)
  - [Making Changes](#making-changes)
  - [Submitting Pull Requests](#submitting-pull-requests)
- [Code Guidelines](#code-guidelines)
- [Community](#community)

## Code of Conduct

We enforce a Code of Conduct in all interactions within our community. Please familiarize yourself with it before participating: [Code of Conduct](CODE_OF_CONDUCT.md).

## Reporting Issues

If you encounter a bug, inconsistency, or have a feature request, please check the [issue tracker](https://github.com/nodeflip/nest-axios-http/issues) to see if it has already been reported or discussed. If not, feel free to [create a new issue](https://github.com/nodeflip/nest-axios-http/issues/new).

## Feature Requests

We welcome suggestions for new features or improvements. Please ensure your feature request is clear and provides sufficient context. You can submit your ideas via [GitHub Issues](https://github.com/nodeflip/nest-axios-http/issues/new).

## Contributing Code

### Setting Up Your Development Environment

To start contributing to `@nodeflip/nest-axios-http`, follow these steps:

1. **Fork the repository**: Click on the "Fork" button on the top right corner of the repository page.

2. **Clone your fork**: Clone the repository to your local machine.

   ```bash
   git clone https://github.com/nodeflip/nest-axios-http.git
   cd nest-axios-http
   ```

3. **Install dependencies**: Install the necessary dependencies.

   ```bash
   npm install
   ```

### Making Changes

- Create a new branch for your feature or bug fix.

  ```bash
  git checkout -b feature-or-bugfix-name
  ```

- Make your changes, following the [code guidelines](#code-guidelines).

### Submitting Pull Requests

1. **Commit your changes**:

   ```bash
   git commit -am 'Add new feature or fix issue #123'
   ```

2. **Push to your fork**:

   ```bash
   git push origin feature-or-bugfix-name
   ```

3. **Submit a Pull Request**:

   - Go to the [Pull Requests](https://github.com/nodeflip/nest-axios-http/pulls) tab of the original repository.
   - Click on "New Pull Request".
   - Provide a clear title and description for your pull request, explaining the purpose of your changes.

## Code Guidelines

- Follow TypeScript and NestJS best practices.
- Maintain consistent coding style and adhere to existing conventions.
- Write clear commit messages and comments.

## Community

Join our community to connect with other contributors and users:

- [GitHub Discussions](https://github.com/nodeflip/nest-axios-http/discussions)

Thank you for contributing to `@nodeflip/nest-axios-http`! Your involvement helps improve our project and supports the community of NestJS developers. We look forward to reviewing your contributions!