Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
name: Bug Report
about: Report a bug in the Page Graph extension
title: "[BUG] "
labels: bug
---

## Environment

- **TYPO3 version**: (e.g. 13.4.5)
- **PHP version**: (e.g. 8.3)
- **Extension version**: (e.g. 1.0.0)
- **Browser**: (e.g. Chrome 120)

## Description

A clear description of the bug.

## Steps to Reproduce

1. Go to ...
2. Click on ...
3. Observe ...

## Expected Behavior

What you expected to happen.

## Actual Behavior

What actually happened.

## Screenshots

If applicable, add screenshots to help explain the problem.

## Additional Context

Any other information that might be relevant (error logs, related configuration, etc.).
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Feature Request
about: Suggest a new feature or improvement
title: "[FEATURE] "
labels: enhancement
---

## Description

A clear description of the feature you would like.

## Use Case

Why is this feature needed? What problem does it solve?

## Proposed Solution

If you have an idea for how this could be implemented, describe it here.

## Alternatives Considered

Any alternative approaches you have considered.

## Additional Context

Any other information, mockups, or references that might be helpful.
17 changes: 17 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## Description

What does this PR do? Briefly describe the changes.

## Related Issue

Closes #<!-- issue number -->

## Checklist

- [ ] PR targets the `develop` branch
- [ ] Code follows PSR-12 and uses `declare(strict_types=1)`
- [ ] PHPStan level 8 passes
- [ ] PHP-CS-Fixer passes
- [ ] Unit tests pass
- [ ] New/changed functionality includes tests
- [ ] Commit messages are clear and descriptive
72 changes: 72 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# Contributing to Page Graph

Thank you for considering a contribution to the `page_graph` TYPO3 extension!

## Branching Model

1. **Fork** this repository on GitHub.
2. Create a **feature branch** from `develop` (e.g. `feature/my-change`).
3. Open a **Pull Request** targeting `develop`.

The `main` branch is reserved for releases and has branch protection enabled.

## Development Setup

### With DDEV (recommended)

```bash
git clone git@github.com:<your-fork>/page-graph.git packages/page_graph
ddev start
ddev composer install
ddev typo3 extension:setup
ddev typo3 cache:flush
```

### Standalone (without DDEV)

```bash
git clone git@github.com:<your-fork>/page-graph.git
cd page-graph
composer install
```

## Coding Standards

- **PSR-12** coding style
- `declare(strict_types=1);` in every PHP file
- Type hints on all parameters and return types
- **PHPStan level 8** must pass without errors

## Running Quality Tools

```bash
# Static analysis
vendor/bin/phpstan analyse

# Code style check
vendor/bin/php-cs-fixer fix --dry-run --diff

# Code style fix
vendor/bin/php-cs-fixer fix

# Unit tests
vendor/bin/phpunit
```

If you use DDEV, prefix commands with `ddev exec`.

## Pull Request Checklist

Before submitting your PR, please ensure:

- [ ] Code follows PSR-12 and uses strict types
- [ ] PHPStan level 8 passes (`vendor/bin/phpstan analyse`)
- [ ] PHP-CS-Fixer passes (`vendor/bin/php-cs-fixer fix --dry-run`)
- [ ] Unit tests pass (`vendor/bin/phpunit`)
- [ ] New features include tests where applicable
- [ ] Commit messages are clear and descriptive
- [ ] PR targets the `develop` branch

## Reporting Issues

Please use the [GitHub issue tracker](https://github.com/rtfirst/page-graph/issues) for bug reports and feature requests. Security vulnerabilities should be reported privately -- see [SECURITY.md](SECURITY.md).
Loading