# 📥 Contributing to Our OptiML

We warmly welcome contributions from the open-source community! Whether you're fixing bugs, improving documentation, proposing new features, or sharing feedback, your input helps us make this project better for everyone.

## 🧭 Getting Started

To get started:

1. **Fork** this repository.
2. **Clone** your fork to your local machine:
   ```bash
   git clone https://github.com/NU-QRG/optiml.git
   ```
3. **Create a new branch** for your feature or fix:
   ```bash
   git checkout -b my-feature-branch
   ```
4. Make your changes locally.
5. **Commit** your changes with clear and descriptive messages.
6. **Push** to your fork:
   ```bash
   git push origin my-feature-branch
   ```
7. Submit a **pull request (PR)** with a description of your changes.

---

## 🧱 Contribution Types

Here are a few ways you can contribute:

- 🔍 Report bugs or issues via [OptiML Issues](https://github.com/NU-QRG/optiml/issues)
- ✨ Add new features
- 🧹 Improve code structure or performance
- 📝 Enhance documentation or tutorials
- ✅ Write or improve tests

---

## ✅ Code Guidelines

- Follow the existing **coding style** and **naming conventions**.
- Keep your pull requests **small and focused**.
- Write **clear commit messages** and include related issue numbers if applicable.
- Test your changes before submitting a pull request.

---

> See our [Quick Start Guide](../intro.md) for more details.

---

## 🙌 Thank You

Thank you for considering contributing to this project! Every little bit helps, and we truly appreciate your support and engagement. ❤️

If you have questions, feel free to reach out by opening an issue or discussion.