# Contributing to NurDouha

Thank you for your interest in contributing to **NurDouha**!
This project aims to build an open-source Islamic platform for Quran reading and other Islamic knowledge tools.

We welcome contributions from developers, designers, and anyone interested in improving the project.

---

## Ways to Contribute

You can contribute in several ways:

* Fix bugs
* Improve the user interface
* Add new features
* Improve documentation
* Suggest improvements
* Add Islamic resources (Hadith, books, etc.)

---

## Development Setup

1. Clone the repository:

```bash
git clone https://github.com/abdellahaarab/NurDouha.git
```

2. Navigate into the project folder:

```bash
cd NurDouha
```

3. Open the project in your editor.

Since the project uses **HTML, TailwindCSS, and JavaScript**, no build process is required.

You can simply open the main file:

```text
web/reader.html
```

---

## Branch Naming

When working on a feature or fix, create a new branch:

```bash
git checkout -b feature-name
```

Examples:

```text
feature-prayer-times
feature-dark-mode
fix-search-bug
```

---

## Commit Guidelines

Write clear commit messages.

Example:

```text
Add verse search improvement
Fix Mushaf mode layout issue
Add prayer times module
```

---

## Submitting a Pull Request

1. Fork the repository
2. Create a new branch
3. Make your changes
4. Commit your changes
5. Push your branch
6. Open a Pull Request

Example:

```bash
git push origin feature-name
```

Then open a Pull Request on GitHub.

---

## Code Style

Please follow these guidelines:

* Use clean and readable code
* Use descriptive variable names
* Keep functions simple
* Comment complex logic when needed

---

## Feature Suggestions

If you want to add a major feature, please open an **Issue** first to discuss it.

Example future features:

* Prayer Times
* Hadith Collections
* Islamic Books
* Quran Audio
* Tafsir Integration
* Dark Mode
* Offline Mode

---

## Community Guidelines

Please keep discussions respectful and constructive.
This project represents an Islamic knowledge platform, so we encourage a respectful environment.

---

## Thank You

Your contributions help make **NurDouha** better for everyone.

May your efforts be rewarded.
