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
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ body:
id: reproduce
attributes:
label: Minimal reproduction
description: Provide the smallest code sample, command, configuration, or repository that reproduces the problem.
description: Provide the smallest code sample, command, configuration or repository that reproduces the problem.
placeholder: |
1. Install or configure ...
2. Run ...
Expand Down Expand Up @@ -108,7 +108,7 @@ body:
id: environment
attributes:
label: Environment
description: Include the operating system, relevant extensions, dependency mode, runtime, and CI provider when applicable.
description: Include the operating system, relevant extensions, dependency mode, runtime and CI provider when applicable.
placeholder: Ubuntu 24.04, locked dependencies, ext-json enabled, GitHub Actions...
validations:
required: true
Expand All @@ -117,4 +117,4 @@ body:
id: additional
attributes:
label: Additional context
description: Add related issues, screenshots, logs, workarounds, or other useful context.
description: Add related issues, screenshots, logs, workarounds or other useful context.
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/ci_failure.yml
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ body:
id: local_details
attributes:
label: Local reproduction details
description: Include the command, result, and any differences from CI.
description: Include the command, result and any differences from CI.
placeholder: composer ic:ci fails locally with the same error...

- type: input
Expand All @@ -83,7 +83,7 @@ body:
id: environment
attributes:
label: Runner and dependency environment
description: Include the runner OS, dependency mode, relevant extensions, matrix values, and PHPForge version when known.
description: Include the runner OS, dependency mode, relevant extensions, matrix values and PHPForge version when known.
placeholder: ubuntu-latest, prefer-lowest, PHPForge 1.x, ext-json enabled...
validations:
required: true
Expand All @@ -92,10 +92,10 @@ body:
id: recent_changes
attributes:
label: Relevant recent changes
description: Mention dependency, configuration, workflow, or source changes that may be related.
description: Mention dependency, configuration, workflow or source changes that may be related.

- type: textarea
id: additional
attributes:
label: Additional context
description: Add related issues, screenshots, logs, or other useful context.
description: Add related issues, screenshots, logs or other useful context.
10 changes: 5 additions & 5 deletions .github/ISSUE_TEMPLATE/docs_improvement.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: Documentation improvement
description: Report missing, outdated, unclear, or incorrect documentation
description: Report missing, outdated, unclear or incorrect documentation
labels:
- documentation
body:
Expand All @@ -21,7 +21,7 @@ body:
id: location
attributes:
label: Documentation location
description: Provide the file path, section, symbol, or URL.
description: Provide the file path, section, symbol or URL.
placeholder: README.md — Quick Start
validations:
required: true
Expand All @@ -30,7 +30,7 @@ body:
id: problem
attributes:
label: Problem
description: Explain what is missing, unclear, outdated, or incorrect.
description: Explain what is missing, unclear, outdated or incorrect.
placeholder: The current documentation says or omits...
validations:
required: true
Expand All @@ -48,11 +48,11 @@ body:
id: suggestion
attributes:
label: Suggested improvement
description: Optionally propose wording, structure, examples, or references.
description: Optionally propose wording, structure, examples or references.
placeholder: It may be clearer to...

- type: textarea
id: additional
attributes:
label: Additional context
description: Add related links, screenshots, discussions, or examples.
description: Add related links, screenshots, discussions or examples.
10 changes: 5 additions & 5 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ body:
value: |
Describe the problem or use case before proposing an implementation.

For substantial public API, architectural, or compatibility changes, discussion may be requested before implementation.
For substantial public API, architectural or compatibility changes, discussion may be requested before implementation.

- type: textarea
id: problem
attributes:
label: Problem or use case
description: Explain the limitation, repeated difficulty, or capability you need.
description: Explain the limitation, repeated difficulty or capability you need.
placeholder: I need to... because...
validations:
required: true
Expand All @@ -32,7 +32,7 @@ body:
id: example
attributes:
label: Example usage
description: Optionally show the proposed API, configuration, command, or workflow.
description: Optionally show the proposed API, configuration, command or workflow.
render: php

- type: textarea
Expand All @@ -45,10 +45,10 @@ body:
id: compatibility
attributes:
label: Compatibility considerations
description: Mention possible public API, behavior, PHP-version, extension, platform, or dependency implications.
description: Mention possible public API, behavior, PHP-version, extension, platform or dependency implications.

- type: textarea
id: additional
attributes:
label: Additional context
description: Add related issues, prior art, links, benchmarks, or other supporting information.
description: Add related issues, prior art, links, benchmarks or other supporting information.
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: Question
description: Ask about usage, behavior, integration, or configuration
description: Ask about usage, behavior, integration or configuration
labels:
- question
body:
Expand All @@ -23,7 +23,7 @@ body:
id: attempted
attributes:
label: What have you tried?
description: Include relevant code, commands, configuration, documentation, or approaches already checked.
description: Include relevant code, commands, configuration, documentation or approaches already checked.
placeholder: I tried...
validations:
required: true
Expand All @@ -46,11 +46,11 @@ body:
id: environment
attributes:
label: Environment
description: Include package, PHP, Composer, OS, extensions, or CI details only when relevant.
description: Include package, PHP, Composer, OS, extensions or CI details only when relevant.
placeholder: Package 2.4.1, PHP 8.4, Composer 2.9, Ubuntu 24.04...

- type: textarea
id: additional
attributes:
label: Additional context
description: Add related links, screenshots, or prior discussions.
description: Add related links, screenshots or prior discussions.
34 changes: 6 additions & 28 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,26 +32,22 @@ Use `Closes #...`, `Fixes #...` or `Relates #...` where applicable.
<!--
Remove the compatibility notes below when no explanation is required.

Describe relevant behavior changes, deprecations, compatibility concerns,
Describe relevant behavior changes, deprecations, compatibility concerns
or upgrade requirements.
-->

## Validation

### Complete Suite

* [ ] `composer ic:ci`

<!--
When `composer ic:ci` passes, do not select focused checks.
-->
<!-- When `composer ic:ci` passes, do not select focused checks. -->

<details>
<summary>Focused validation</summary>

<!--
Use only when `composer ic:ci` was not run or could not complete.
Select every command that passed.
Select every command that passed and explain the limitation below.
-->

* [ ] `composer ic:test:syntax`
Expand All @@ -68,21 +64,11 @@ Select every command that passed.

</details>

### Coverage

* [ ] Expected or newly introduced behavior
* [ ] Regression scenario
* [ ] Boundary and edge cases
* [ ] Failure and exception paths
* [ ] Public API compatibility
* [ ] Version, dependency, extension or platform-specific behavior
* [ ] Not applicable

<!--
Remove the validation notes below when `composer ic:ci` passed without
relevant limitations.

Explain skipped or failed checks, environment limitations, manual validation,
Explain skipped or failed checks, environment limitations, manual validation
or other relevant results.
-->

Expand All @@ -95,16 +81,10 @@ is being made.

* [ ] Relevant benchmarks were added or updated
* [ ] Results were compared against a relevant baseline

<details>
<summary>Benchmark commands</summary>

* [ ] `composer ic:benchmark`
* [ ] `composer ic:bench:quick`
* [ ] `composer ic:bench:chart`

</details>

<!--
Environment:
Baseline:
Expand All @@ -127,9 +107,7 @@ excluded work.
<!--
Remove this section when no special review focus is required.

Highlight areas that deserve additional reviewer attention, such as public API
compatibility, edge cases, exception handling, performance-sensitive paths,
version compatibility or security-sensitive logic.
Highlight areas that deserve additional reviewer attention.
-->

## Checklist
Expand All @@ -140,4 +118,4 @@ version compatibility or security-sensitive logic.
* [ ] Documentation, examples and type information were updated where required.
* [ ] Performance claims are supported by reproducible benchmarks.
* [ ] No credentials, secrets, personal data or sensitive debug output are included.
* [ ] I followed `CONTRIBUTING.md`.
* [ ] I followed `CONTRIBUTING.md` and the engineering principles.
94 changes: 94 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/bug_fix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
## Problem

Describe the incorrect behavior, its impact and how it can be reproduced.

<!--
Link relevant issues, discussions or reports when available.
Use `Closes #...`, `Fixes #...` or `Relates #...` where applicable.
-->

## Root Cause

<!--
Remove this section when the root cause is unknown or the explanation adds no
review value.

Explain why the problem occurred.
-->

## Fix

Describe how the change corrects the problem and the expected behavior after the fix.

## Behavior and Compatibility

* [ ] Existing documented behavior was restored
* [ ] Existing undocumented behavior was corrected
* [ ] Public API remains compatible
* [ ] Public API or documented behavior changed
* [ ] Backward compatibility may be affected
* [ ] PHP, extension, platform or dependency requirements changed

<!--
Remove the compatibility notes below when no explanation is required.

Describe compatibility concerns, deprecations or upgrade requirements.
-->

## Validation

* [ ] `composer ic:ci`
* [ ] The original failure no longer reproduces
* [ ] A regression test was added or updated
* [ ] Relevant boundary and failure paths were tested

<!-- When `composer ic:ci` passes, do not select focused checks. -->

<details>
<summary>Focused validation</summary>

<!--
Use only when `composer ic:ci` was not run or could not complete.
Select every command that passed and explain the limitation below.
-->

* [ ] `composer ic:test:syntax`
* [ ] `composer ic:test:code`
* [ ] `composer ic:test:lint`
* [ ] `composer ic:test:sniff`
* [ ] `composer ic:test:duplicates`
* [ ] `composer ic:test:probe`
* [ ] `composer ic:test:comments`
* [ ] `composer ic:test:architecture`
* [ ] `composer ic:test:static`
* [ ] `composer ic:test:security`
* [ ] `composer ic:test:refactor`

</details>

<!--
Remove the validation notes below when complete validation passed without
limitations.

Explain skipped checks, environment limitations, manual validation or why a
regression test was not appropriate.
-->

## Review Focus

<!--
Remove this section when no special review focus is required.

Highlight the root cause, regression risk, compatibility concern or edge case
that deserves additional attention.
-->

## Checklist

* [ ] The fix is focused and excludes unrelated changes.
* [ ] The fix addresses the root cause rather than only masking symptoms.
* [ ] Regression-prone behavior is covered by tests.
* [ ] Public API and backward-compatibility implications were considered.
* [ ] Documentation and examples were updated where required.
* [ ] No credentials, secrets, personal data or sensitive debug output are included.
* [ ] I followed `CONTRIBUTING.md` and the engineering principles.
51 changes: 51 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
## Documentation Change

Describe what is being added, corrected, clarified or removed and why.

<!--
Link relevant issues, discussions, code, releases or external references when available.
Use `Closes #...`, `Fixes #...` or `Relates #...` where applicable.
-->

## Affected Content

* [ ] README or getting-started guidance
* [ ] API or reference documentation
* [ ] Configuration documentation
* [ ] Examples or tutorials
* [ ] Contribution or community documentation
* [ ] Changelog or release documentation
* [ ] Other

## Verification

* [ ] Links and references were checked
* [ ] Code examples were executed or otherwise verified
* [ ] Commands and configuration examples match current behavior
* [ ] Terminology is consistent with the project
* [ ] `composer ic:ci`
* [ ] No executable behavior changed

<!--
Remove the verification notes below when no explanation is required.

Explain any example that could not be executed, generated content that was
updated or validation limitation.
-->

## Review Focus

<!--
Remove this section when no special review focus is required.

Highlight technical accuracy, intended audience, migration wording, examples
or terminology that deserves additional attention.
-->

## Checklist

* [ ] The change is focused and excludes unrelated code changes.
* [ ] Documentation reflects the current public behavior.
* [ ] Examples are minimal, accurate and safe to copy.
* [ ] Sensitive or private information is not included.
* [ ] I followed `CONTRIBUTING.md` and the engineering principles.
Loading