@specialman/gsubz/CONTRIBUTING.md

Node JS library for GSUBZ APIs

# Contributor Guidelines

Welcome! This project is created by the team at [Special Man Global Solution LTD](https://specialmansolution.com/). We're glad you're interested in contributing!

## **Have a Question?**

If you have any inquiries, ideas, or wish to collaborate, feel free to reach out to us via email at engineering@specialmansolution.com.

> **Please avoid opening an issue just to ask a question.**

## How to Contribute

### Feature Suggestions

Do you have an idea that could improve this project? We'd love to hear about it! Submit a GitHub issue outlining the feature, ensuring you include:

1. A descriptive and clear title.
2. A brief but detailed explanation of your idea.
3. The use case for this feature.
4. The library name and version you are referencing.

### Reporting Issues

If you encounter a bug or unexpected behavior, follow these steps:

1. First, check if the issue has already been reported. If it exists, add your comments rather than creating a duplicate.
2. Provide detailed steps to reproduce the problem, including:
   - The platform or environment you are using.
   - The steps leading to the issue.
   - Any error messages received.

> **💡 Tip:** Use the provided issue template when submitting a bug report.

### Submitting Code Changes

We welcome contributions in the following areas:

- Fixing bugs
- Enhancing performance
- Improving documentation
- Adding new features

> **💡 Note:** Purely cosmetic changes that do not improve functionality, stability, or testability may not be accepted.

## Contribution Process

### Finding Issues to Work On

Browse through our open issues and pick one that interests you. Feel free to comment on an issue if you’d like to work on it or if you have questions.

### Making Changes

1. Fork the repository to your own GitHub account.
2. Create a feature branch.
3. If applicable, write tests for your changes and ensure all tests pass.
4. For functionality updates, document how to use the new feature.
5. Use clear and meaningful commit messages.
6. Complete all sections of the pull request template before submitting.
7. Submit your pull request against the `dev` branch.
8. A maintainer will review your submission and may request changes.

For guidance on creating a pull request, visit [GitHub’s documentation](https://help.github.com/en/articles/creating-a-pull-request-from-a-fork).

## Contributor Terms

By contributing to this project (through code, feedback, or suggestions), you agree to the Contributor Terms outlined here.

Additionally, please adhere to our [Contributor Code of Conduct](CODE_OF_CONDUCT.md) when participating in this project.