Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (47 loc) · 3.15 KB

CONTRIBUTING.md

File metadata and controls

69 lines (47 loc) · 3.15 KB
Raw

Contributing Guide

Thank you for contributing to CKEditor 5 Editor Bundle.

Table of contents

Code of Conduct

This project follows the Contributor Covenant Code of Conduct. By participating, you are expected to uphold it. Please report unacceptable behavior to hectorfranco@nowo.tech.

How to contribute

Reporting bugs

  1. Check existing issues.
  2. Open a new issue with steps to reproduce, expected vs actual behaviour, and versions (composer info nowo-tech/ckeditor5-editor-bundle, php -v, Symfony version).

Suggesting enhancements

Open an issue describing the use case, expected behaviour, and optional implementation ideas.

Contributing code

  1. Fork and clone the repository.
  2. Install PHP dependencies: composer install (or Docker: make up).
  3. Build frontend assets when touching TS: make assets or pnpm install && pnpm run build.
  4. Run quality checks: make release-check or at minimum composer qa, composer phpstan, composer test, and pnpm run test:coverage when TS changes. PHPStan includes nowo-tech/phpstan-frankenphp classic + worker rulesets (phpstan.neon.dist); keep findings green before claiming FrankenPHP worker friendliness.
  5. Update docs/CHANGELOG.md under [Unreleased] for user-visible changes.
  6. Open a pull request against main using .github/PULL_REQUEST_TEMPLATE.md.

Project layout

  • src/ — Bundle code (DI extension, form type, Twig extension, compiler passes).
  • src/Resources/ — Twig themes, translations, Vite sources, published public/ JS.
  • tests/ — PHPUnit (Unit, Integration).
  • demo/ — FrankenPHP demo: symfony8 (Symfony 8.1, port 8021); not shipped in the Composer package.

CI runs PHPUnit on PHP 8.2–8.5 × Symfony 7.0 / 7.4 / 8.0 / 8.1 (Symfony 8.x jobs use PHP ≥8.4).

Code style

  • PHP: PSR-12 via PHP-CS-Fixer (composer cs-check / composer cs-fix).
  • PHPDoc and comments in English.
  • TypeScript: strict settings where used; English JSDoc for shared helpers.

Questions

Open a support issue from the issue templates or use repository Discussions if enabled.

Git hooks (REQ-GIT-001)

Do not add Co-authored-by: Cursor or cursoragent@cursor.com trailers to commit messages.

make setup-hooks
make check-no-cursor-coauthor

make setup-hooks installs .githooks/commit-msg (or sets core.hooksPath to .githooks). Run it once per clone before your first commit. If CI fails because trailers are already on the remote, see GITHUB_CI.md (REQ-GIT-001) and run make strip-cursor-coauthor-from-history before git push --force-with-lease.