# 🎉 Contributing to **TypeSafeEnv** 🎉

Thank you for considering contributing to **TypeSafeEnv**! We're excited to have you involved in making this project even better. Whether you're fixing bugs, adding features, or improving the documentation, every bit helps!

## 💡 How Can You Contribute?

There are several ways you can contribute to **TypeSafeEnv**:

- 🐛 **Bug Reports**: If you find any bugs or unexpected behavior, feel free to open an issue and provide as much detail as possible.
- ✨ **Features**: If you have an idea for a new feature, let us know! We welcome suggestions that improve the usability and flexibility of the package.
- 📄 **Documentation**: Help us improve the documentation, whether it's fixing typos, enhancing explanations, or adding new examples.
- 🔨 **Code**: If you're feeling hands-on, you can contribute code! We welcome pull requests for bug fixes, features, or optimizations.

---

## 🛠️ Setting Up Your Development Environment

To get started with contributing, follow these steps to set up your local environment:

1. **Fork the repository**: Click the "Fork" button at the top-right of this page to create a personal copy of the repository.

2. **Clone your fork**:

   ```bash
   git clone https://github.com/Innocent6303/typesafe-env.git
   ```

3. **Install dependencies**:

   Navigate to the project directory and run:

   ```bash
   cd typesafe-env
   npm install
   ```

4. **Run the project**: To ensure everything works properly, you can run the project and test the existing features:

   ```bash
   npm run dev
   ```

---

## ⚙️ How to Submit a Pull Request

Once you've made your changes and tested them locally, you can submit a pull request. Please follow these steps:

1. **Commit your changes**: Make sure your commit message is clear and follows the [Conventional Commits](https://www.conventionalcommits.org/) format.

   Example:

   ```bash
   git commit -m "feat: add new validation for JSON variables"
   ```

2. **Push your changes**:

   ```bash
   git push origin your-branch-name
   ```

3. **Open a Pull Request**: Go to the repository on GitHub and open a pull request with a description of your changes. Ensure you follow the [PR template](#PR-Template).

---

## ⚡️ PR Template

Please make sure your pull request follows this template. Feel free to fill in each section appropriately.

---

**Title**: Short summary of your change

### Description:

- What did you change? Why was this change necessary?

### Issue Number:

- If applicable, link to the issue you're addressing (e.g., #42).

### Screenshots/Examples:

- Provide any relevant screenshots or usage examples if applicable.

### Tests:

- Did you write tests for the new functionality or bug fix? How did you test your changes?

---

## 🚀 Code of Conduct

We are committed to creating a welcoming environment for everyone. Please review and adhere to our [Code of Conduct](https://www.contributor-covenant.org/version/2/0/code_of_conduct/).

---

## 🙏 A Big Thank You!

We are incredibly grateful for your contributions! Each and every contribution helps to make **TypeSafeEnv** better, and we truly appreciate the time and effort you put into it.

---

## ✨ Your Contributions Matter!

Thank you for helping to make **TypeSafeEnv** the go-to tool for validating environment variables in large-scale projects. We look forward to seeing your contributions and collaborating with you!

---

### Made with ❤️ by **Abdul Mujeeb**