validis/CONTRIBUTING.md

Validation made simple! 🚀 This package gives you all the tools you need to quickly and effortlessly validate emails, phone numbers, passwords, character limits, and more. Whether you’re checking for a positive number, enforcing a specific range, or custo

# Contributing to Validis 🎉

Thank you for your interest in contributing to **Validis**! We welcome all contributions, whether it's fixing bugs, improving documentation, or adding new features. Before contributing, please read the following guidelines to ensure a smooth collaboration.

## 📌 Getting Started

1. **Fork the Repository**: Click on the 'Fork' button at the top right of the repo.
2. **Clone Your Fork**: Run the following command in your terminal:
   ```sh
    https://github.com/kriparajp1/validis.git
   ```
3. **Navigate to the Project Directory**:
   ```sh
   cd validis
   ```
4. **Install Dependencies**:
   ```sh
   npm install
   ```
5. **Create a New Branch**:
   ```sh
   git checkout -b feature-or-bugfix-name
   ```

## 🛠 How to Contribute

### 🔹 Reporting Bugs
If you find a bug, please [open an issue](https://github.com/kriparajp1/validis/issues) and include:
- A clear, descriptive title
- Steps to reproduce the bug
- Expected vs. actual behavior
- Any relevant screenshots or error messages

### 🔹 Suggesting Features
We love new ideas! If you have a feature request, [open an issue](https://github.com/kriparajp1/validis/issues) and provide details about:
- Why the feature is useful
- Potential implementation ideas
- Any alternatives you considered

### 🔹 Fixing Issues & Submitting Pull Requests (PRs)
1. **Find an Issue**: Check the [Issues](https://github.com/kriparajp1/validis/issues) tab and pick one to work on.
2. **Make Your Changes**:
   - Follow the existing coding style.
   - Ensure your code is well-documented and tested.
3. **Commit Your Changes**:
   ```sh
   git add .
   git commit -m "feat: add validation for min length"
   ```
4. **Push to Your Fork**:
   ```sh
   git push origin feature-or-bugfix-name
   ```
5. **Create a Pull Request**:
   - Go to the [Validis repository](https://github.com/kriparajp1/validis)
   - Click on 'New Pull Request'
   - Select your branch and provide a meaningful PR description
   - Wait for review and approval 🚀

## ✅ Code Guidelines
- Follow **ESLint rules** for consistent formatting.
- Keep code modular and reusable.
- Use meaningful commit messages (e.g., `fix: correct regex validation`).
- Write **unit tests** for new functions (if applicable).

## 💡 Need Help?
If you need any assistance, feel free to reach out by opening an issue or contacting [Kriparaj P](https://github.com/kriparajp1) directly.

Happy Coding! 🎉