Profiler readme

[jan888adams]

Summary by CodeRabbit

• Documentation
  • Added a profiling guide that explains how to enable and use the Symfony Profiler, notes the default behavior in the development environment, and shows how to enable profiling in other environments.
  • Includes guidance on inspecting cache tags exposed in response headers and reviewing profiler-related bundle configuration.

[coderabbitai]

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Walkthrough

Adds a new documentation page explaining bundle profiling: enabling the Symfony Profiler, default dev behavior, registering WebProfilerBundle for other environments, inspecting cache tags in response headers, and checking bundle configuration.

Changes

Cohort / File(s)	Summary
Documentation: Profiling Guide doc/10-profiling.md	New documentation file describing profiling capabilities, steps to enable the Symfony Profiler (including registering WebProfilerBundle), default dev-environment behavior, how to expose and inspect cache tags in response headers, and guidance for inspecting bundle configuration.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

• Documentation-only addition; no code changes.
• Review focus: accuracy of instructions, correctness of command/config names (e.g., WebProfilerBundle), and clarity of cache-tag inspection steps.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Profiler readme' accurately describes the main change—adding a new documentation file about profiling capabilities to the repository.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch readme-for-cache-tag-profiler

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 471f9a8 and cfb1cbb.

📒 Files selected for processing (1)

• doc/10-profiling.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• doc/10-profiling.md

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[Copilot]

Pull Request Overview

This PR adds two new documentation files to the bundle: one for profiling features and one for contribution guidelines.

• Added profiling documentation explaining the Symfony Profiler integration
• Added contribution guidelines covering local development setup and quality tools

Reviewed Changes

Copilot reviewed 1 out of 2 changed files in this pull request and generated 1 comment.

File	Description
doc/10-profiling.md	Introduces documentation for using the Symfony Profiler to debug cache tags and inspect bundle configuration
doc/11-contribution.md	Provides contribution guidelines including Docker setup, dependency installation, and quality tool commands

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

doc/10-profiling.md (1)

1-6: Expand documentation with actionable instructions and examples.

The documentation introduces profiling capabilities but lacks implementation details and examples. Users cannot actually use these features based on the current content.

Consider adding:

• Step-by-step instructions to enable the Symfony Profiler
• How to view cache tags in response headers (e.g., which headers to inspect, web profiler toolbar location)
• Configuration inspection examples (e.g., which profiler panel or command to use)
• Code snippets or configuration examples where applicable

Is this documentation intentionally a minimal stub pending expansion in follow-up work, or should it be more complete before merging?

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8dd01f4 and 471f9a8.

📒 Files selected for processing (1)

• doc/10-profiling.md (1 hunks)

🧰 Additional context used

🧠 Learnings (1)

📓 Common learnings

Learnt from: jan888adams
Repo: teamneusta/pimcore-http-cache-bundle PR: 0
File: :0-0
Timestamp: 2025-04-17T08:05:45.864Z
Learning: The PR #18 in teamneusta/pimcore-http-cache-bundle successfully standardized all PHP files in the repository to have the strict_types declaration on the same line as the PHP opening tag (<?php declare(strict_types=1);), except for configuration files (.php-cs-fixer.php and config/services.php) which intentionally omit strict_types declarations.

Learnt from: jan888adams
Repo: teamneusta/pimcore-http-cache-bundle PR: 0
File: :0-0
Timestamp: 2025-04-17T08:05:45.864Z
Learning: In the teamneusta/pimcore-http-cache-bundle project, a PR was created to ensure consistent formatting of strict_types declarations across the codebase, with the preferred format being to have the strict_types declaration on the same line as the PHP opening tag (<?php declare(strict_types=1);).

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Upload results