Skip to content

Commit 3a19ae4

Browse files
authored
Update CONTRIBUTING.md for clearer setup guidance
Clarify repository purposes and local setup instructions.
1 parent b93a6ca commit 3a19ae4

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,29 @@ Don’t hesitate to open a new issue if you find something worth improving.
1414

1515
## Local Setup (Fork-Based)
1616

17+
Quantum consists of **two repositories** that serve different purposes:
18+
19+
🧩 1. `quantum-php-core` **(The core framework)**
20+
21+
If your goal is to contribute to the core framework (e.g., routing, DI, ORM, view engine, etc.):
22+
1723
1. Fork the repository on GitHub and clone your fork locally:
1824

1925
```bash
2026
git clone https://github.com/your-username/quantum-php-core.git
2127
cd quantum-php-core
2228
composer install
29+
vendor/bin/phpunit --stderr
30+
```
31+
32+
🚀 2. `quantum-php-project` **(Starter Project)**
33+
34+
If you want to run Quantum project locally, see how modules work, or test the framework in action, use the starter project:
35+
36+
```bash
37+
git clone https://github.com/softberg/quantum-php-project.git
38+
cd quantum-php-project
39+
composer install
2340
php qt serve
2441
```
2542

@@ -56,7 +73,7 @@ git push origin feature/your-feature-name
5673

5774
## Testing
5875

59-
Quantum uses PHPUnit for tests. If you add new features, make sure they include unit tests — especially for database or HTTP-related components. For in-memory testing, use SQLite in-memory databases (for example, in tests using IdiormDbal).
76+
Quantum uses **PHPUnit** for tests. If you add new features, make sure they include unit tests — especially for database or HTTP-related components. For in-memory testing, use SQLite in-memory databases (for example, in tests using IdiormDbal).
6077

6178
---
6279

0 commit comments

Comments
 (0)