Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
70 lines (48 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

70 lines (48 loc) · 1.78 KB
Raw

Contributing

Thank you for considering contributing to Api Studio 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.

Development setup

  1. Clone the repository and start Docker:

    make up
make install

  2. Run tests:

    make test
make test-coverage

  3. Code style and static analysis:

    make cs-check
make cs-fix
make phpstan
make validate-translations
make qa

  4. Frontend assets (TypeScript → src/Resources/public/), via pnpm in Docker:

    make assets

Pull requests

  • Target the main branch.
  • Run make release-check before opening a PR.
  • Update docs/CHANGELOG.md for user-visible changes.
  • Complete the PR template checklist.

Reporting issues

Use GitHub issue templates. Do not report security vulnerabilities in public issues — see Security.

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.