Skip to content

Conversation

@martin-georgiev
Copy link
Owner

@martin-georgiev martin-georgiev commented Nov 20, 2025

Summary by CodeRabbit

  • Chores
    • Implemented structured bug report template with diagnostic fields, reproduction steps, and version collection
    • Added security vulnerability reporting template with responsible disclosure guidance
    • Created feature request template with use case and alternative solutions sections
    • Implemented documentation feedback template for issue reporting
    • Configured issue template settings with resource links and disabled blank issue creation

✏️ Tip: You can customize this high-level summary in your review settings.

@martin-georgiev martin-georgiev merged commit d8c2f5d into main Nov 20, 2025
90 of 92 checks passed
@martin-georgiev martin-georgiev deleted the contributing branch November 20, 2025 02:03
@coderabbitai
Copy link

coderabbitai bot commented Nov 20, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

Adds five new GitHub issue templates and a configuration file to the .github/ISSUE_TEMPLATE/ directory. The templates establish structured forms for bug reports, feature requests, documentation issues, and security vulnerability disclosures. The configuration file disables blank issues and provides contact links directing users to documentation, discussions, and contribution guidelines.

Changes

Cohort / File(s) Summary
Issue Templates Configuration
​.github/ISSUE_TEMPLATE/config.yml
Disables blank issues and defines contact links (Documentation, GitHub Discussions, Contributing Guide, Sponsor) to guide users when creating issues
Bug Report Template
​.github/ISSUE_TEMPLATE/bug_report.yml
Structured form capturing description, expected vs. actual behavior, reproduction steps, code samples, error traces, component categorization, and version information (package, PHP, Doctrine DBAL/ORM, PostgreSQL, PostGIS)
Feature Request Template
​.github/ISSUE_TEMPLATE/feature_request.yml
Form for feature proposals including problem statement, solution, feature type, PostgreSQL identifiers, use cases, code examples, alternatives, and pre-submission checklist
Documentation Template
​.github/ISSUE_TEMPLATE/documentation.yml
Form for documentation issues covering issue type, affected documentation section, current content, suggested improvements, examples, and contributor willingness
Security Template
​.github/ISSUE_TEMPLATE/security.yml
Form for vulnerability reporting with severity levels, description, type, affected component, impact, reproduction steps, proof of concept, environment details, and responsible disclosure confirmations

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • All files are template/configuration additions with no logic changes
  • Changes are homogeneous in nature—YAML form definitions with consistent structure
  • Minimal review needed beyond verifying form field completeness, placeholder clarity, and required field appropriateness
  • Minor attention points:
    • Verify all required fields appropriately enforce diagnostic information collection
    • Confirm contact links in config.yml are accurate and current
    • Ensure version fields align with project's actual support matrix

Poem

🐰 Hop and skip! Templates taking flight,
Issue forms now structured right!
From bugs to features, security too,
Organized paths for all to pursue!
Doctrine's PostgreSQL shines so bright! ✨🐇

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch contributing

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 425f962 and 5579552.

📒 Files selected for processing (5)
  • .github/ISSUE_TEMPLATE/bug_report.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/config.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/documentation.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/feature_request.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/security.yml (1 hunks)

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

  • Provide your own instructions using the high_level_summary_instructions setting.
  • Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
  • Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

  1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
  2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
  3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
  4. 📊 Contributor Summary — Include a Markdown table showing contributions:
    | Contributor | Lines Added | Lines Removed | Files Changed |
  5. ✔️ Additional Notes — Add any extra reviewer context.
    Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.


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

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

@coveralls
Copy link

Coverage Status

coverage: 95.725%. remained the same
when pulling 5579552 on contributing
into 425f962 on main.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants