smartstepper/CONTRIBUTING.md

SmartStepper is a modern, customizable React stepper component for building multi-step forms, wizards, and onboarding flows. Integrates with react-hook-form, supports Yup/Zod validation, and offers a flexible, config-driven API for dynamic forms.

# Contributing to SmartStepper

Thank you for your interest in contributing to **SmartStepper**! Your help is greatly appreciated. Please follow these guidelines to make the process smooth for everyone.

## Table of Contents
- [Contributing to SmartStepper](#contributing-to-smartstepper)
  - [Table of Contents](#table-of-contents)
  - [Code of Conduct](#code-of-conduct)
  - [Getting Help](#getting-help)
  - [Reporting Bugs](#reporting-bugs)
  - [Suggesting Features](#suggesting-features)
  - [Project Setup](#project-setup)
  - [Development Workflow](#development-workflow)
  - [Coding Standards](#coding-standards)
  - [Submitting Pull Requests](#submitting-pull-requests)
  - [Community Guidelines](#community-guidelines)
  - [License](#license)
  - [Acknowledgements](#acknowledgements)
  - [Commit Message Guidelines](#commit-message-guidelines)
  - [Templates](#templates)

---

## Code of Conduct
This project adheres to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.

## Getting Help
If you have questions or need help, please open a [GitHub Discussion](https://github.com/Miladxsar23/smartstepper/discussions) or create an issue.

## Reporting Bugs
- Search [issues](https://github.com/Miladxsar23/smartstepper/issues) to see if your bug is already reported.
- If not, open a new issue and include:
  - A clear, descriptive title
  - Steps to reproduce
  - Expected and actual behavior
  - Screenshots or code snippets if possible
  - Your environment (OS, Node.js version, browser, etc.)

## Suggesting Features
- Check [issues](https://github.com/Miladxsar23/smartstepper/issues) for existing feature requests.
- Open a new issue with:
  - A clear, descriptive title
  - A detailed description of the feature and its use case
  - Any relevant examples or references

## Project Setup
1. **Fork** the repository and **clone** your fork.
2. Install dependencies:
   ```bash
   npm install
   ```
3. Run the development server or build/test scripts as needed:
   ```bash
   npm run build
   npm test
   ```

## Development Workflow
- Create a feature or fix branch from `master` (e.g., `feature/your-feature` or `fix/your-bug`).
- Make your changes and ensure all tests pass.
- Submit a pull request and request a review.
- One or more maintainers will review your PR. Please respond to feedback promptly.

## Coding Standards
- Use [Prettier](https://prettier.io/) and [ESLint](https://eslint.org/) for code formatting and linting.
- Write clear, concise, and well-documented code.
- Use descriptive commit messages (e.g., `fix: correct step validation logic`).
- Add or update tests for new features and bug fixes.

## Submitting Pull Requests
1. Create a new branch for your feature or bugfix.
2. Make your changes and commit them.
3. Push your branch to your fork.
4. Open a pull request against the `master` branch of the main repository.
5. Fill out the PR template and describe your changes clearly.
6. Ensure all checks pass (CI, tests, linting).

## Community Guidelines
- Be respectful and inclusive.
- Provide constructive feedback.
- Help others when possible.
- Follow the [Code of Conduct](https://opensource.guide/code-of-conduct/).

## License
By contributing, you agree that your contributions will be licensed under the [MIT License](../LICENSE).

## Acknowledgements
Thanks to all contributors and the open source community for making SmartStepper better!

## Commit Message Guidelines
We use [Conventional Commits](https://www.conventionalcommits.org/) for commit messages (e.g., `feat: add new stepper animation`).

## Templates
Please use the provided issue and pull request templates to help us address your contribution efficiently.

---

Thank you for helping make **SmartStepper** better!