Contributing

# Fork the framework repository on GitHub, then:
git clone https://github.com/YOUR_USERNAME/framework.git glueful-framework
cd glueful-framework

# Add upstream remote
git remote add upstream https://github.com/glueful/framework.git

composer install

git checkout -b feature/your-feature-name
# or
git checkout -b fix/bug-description

# Check code style
composer phpcs

# Fix code style
composer phpcbf
# or
composer format

<?php

namespace Tests\Feature;

use PHPUnit\Framework\TestCase;

class ExampleTest extends TestCase
{
    public function test_example_feature()
    {
        $result = someFunction();

        $this->assertEquals('expected', $result);
    }
}

# Run all tests
composer test

# Run specific test
./vendor/bin/phpunit tests/Feature/ExampleTest.php

# Run with coverage
composer test:coverage

# Run a suite
composer test:unit
composer test:integration

# Run tests
composer test

# Check code style
composer phpcs

# Fix code style issues
composer phpcbf

# Run static analysis
composer analyse
# or
composer phpstan

# Good commit messages
git commit -m "Add user authentication feature"
git commit -m "Fix cache invalidation bug in Redis driver"
git commit -m "Update database migration documentation"

# Bad commit messages
git commit -m "Fix stuff"
git commit -m "WIP"
git commit -m "Updates"

type(scope): subject

body

footer

feat(auth): add JWT token refresh endpoint

Implement token refresh functionality to allow users to renew
their authentication tokens without re-logging in.

Closes #123

git push origin feature/your-feature-name

**Describe the bug**
A clear description of what the bug is.

**To Reproduce**
Steps to reproduce:
1. Go to '...'
2. Click on '....'
3. See error

**Expected behavior**
What you expected to happen.

**Actual behavior**
What actually happened.

**Environment:**
- Glueful version: [e.g. 1.0.0]
- PHP version: [e.g. 8.2.0]
- Database: [e.g. MySQL 8.0]
- OS: [e.g. Ubuntu 22.04]

**Additional context**
Any other relevant information.

**Code samples**
```php
// Relevant code

## Suggesting Features

### Feature Request Template

```markdown
**Is your feature request related to a problem?**
A clear description of the problem.

**Describe the solution**
How you'd like it to work.

**Describe alternatives**
Alternative solutions you've considered.

**Additional context**
Any other context or examples.

# Clone repository
git clone https://github.com/glueful/glueful.git
cd glueful

# Install dependencies
composer install

# Copy environment file
cp .env.example .env

# Configure database
# Edit .env with your settings

# Run migrations
php glueful migrate:run

cd docs
pnpm install
pnpm run dev

// ✅ Good - strict types, type hints
declare(strict_types=1);

public function process(string $name, int $age): User
{
    // ...
}

// ❌ Bad - no types
public function process($name, $age)
{
    // ...
}

// ✅ Good - specific exceptions
if (!$user) {
    throw new UserNotFoundException("User {$id} not found");
}

// ❌ Bad - generic exception
if (!$user) {
    throw new Exception("Error");
}

// ✅ Good - constructor injection
public function __construct(
    private UserRepository $users,
    private EmailService $email
) {}

// ❌ Bad - static calls
public function process()
{
    $users = UserRepository::getInstance();
}

tests/
├── Unit/           # Unit tests
├── Feature/        # Feature/integration tests
└── TestCase.php    # Base test class

// ✅ Good - clear, focused test
public function test_creates_user_with_valid_data()
{
    $data = ['name' => 'John', 'email' => '[email protected]'];

    $user = $this->userService->create($data);

    $this->assertNotNull($user->id);
    $this->assertEquals('John', $user->name);
}

// ❌ Bad - tests multiple things
public function test_user_service()
{
    // Creates user
    // Updates user
    // Deletes user
    // All in one test
}

/**
 * Process user registration
 *
 * @param  array  $data  User registration data
 * @return User  The created user
 * @throws ValidationException
 */
public function register(array $data): User
{
    // ...
}