Skip to content

docs: Overhaul contributor infrastructure and add GitHub templates - #424

Closed
pradeepkch6-ai wants to merge 1 commit into
durable-workflow:v2from
pradeepkch6-ai:docs/contributor-infrastructure
Closed

docs: Overhaul contributor infrastructure and add GitHub templates#424
pradeepkch6-ai wants to merge 1 commit into
durable-workflow:v2from
pradeepkch6-ai:docs/contributor-infrastructure

Conversation

@pradeepkch6-ai

Copy link
Copy Markdown
Contributor

Description

This PR improves the contributor onboarding experience by overhauling the repository's contributor infrastructure.

The existing CONTRIBUTING.md was highly focused on the regression-corpus contract (which is critical), but lacked guidance on environment setup, local testing, and static analysis. I have expanded the documentation to extract the existing workflows defined in composer.json (composer ecs, composer stan, composer test) into a clear onboarding guide.

The original regression-corpus instructions have been strictly preserved in a dedicated section.

Additionally, this PR introduces:

  • A Bug Report template (requesting PHP/Laravel/Engine versions)
  • A Feature Request template
  • A Pull Request template with a self-review checklist mapping to the CI requirements.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change
  • This change requires a documentation update

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation

- Expands CONTRIBUTING.md with setup, code style (ECS), static analysis (PHPStan), and testing instructions derived from composer.json.

- Preserves the existing regression-corpus contract documentation.

- Adds .github/ISSUE_TEMPLATE for bug reports and feature requests.

- Adds .github/PULL_REQUEST_TEMPLATE.md with a CI-aligned checklist.
@rmcdaniel

Copy link
Copy Markdown
Member

Thank you for this contribution. The expanded contributor setup, testing, and regression-corpus guidance is useful and is being incorporated from this exact revision.

We cannot merge the repository-local issue templates because this organization uses centralized structured issue forms; adding local templates here would replace that intake surface. The pull-request checklist, branch reference, release examples, and product positioning also need a small revision before landing.

We are preparing that corrected integration while preserving your contribution attribution. I am leaving this PR open until the resulting change has landed and required checks are green, then I will follow up here with the incorporated result and close it cleanly.

rmcdaniel pushed a commit that referenced this pull request Aug 15, 2026
Co-authored-by: Pradeep Chilukury <chilukurypradeepkumar@gmail.com>
@rmcdaniel

Copy link
Copy Markdown
Member

Completed in f0e03c9181a4 on v2.

No package release was required for this source-only change.

Required public qualification build (php.yml) passed in run 31860885021.

@rmcdaniel rmcdaniel closed this Aug 15, 2026
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.

2 participants