Skip to content

Conversation

@theaminuli
Copy link
Member

@theaminuli theaminuli commented Oct 27, 2025

What?

Adds standard GitHub repository files to improve contribution workflow:

  • .github/SUPPORT.md - Support and help resources
  • .github/PULL_REQUEST_TEMPLATE.md - Pull request template
  • .github/ISSUE_TEMPLATE/bug_report.yml - Structured bug report form
  • .github/ISSUE_TEMPLATE/feature_request.md - Feature request template
  • LICENSE.md - GPL-2.0 license file (already exists, no changes needed)

Why?

These files are missing and are standard across this project

Current problems:

  • ❌ No guidance on where to get help vs. report bugs
  • ❌ Inconsistent PR quality
  • ❌ Bug reports missing critical info (reproduction steps, environment)
  • ❌ Vague feature requests

This PR fixes:

  • ✅ Directs users to correct support channels (Slack, forums)
  • ✅ Standardizes PR format (What/Why/How)
  • ✅ Ensures complete bug reports with required fields
  • ✅ Encourages problem-focused feature requests

Fixes: #52

How?

All files follow proven WordPress project templates:

  1. SUPPORT.md - Links to #core-ai Slack, forums
  2. PULL_REQUEST_TEMPLATE.md - What/Why/How sections + testing instructions
  3. bug_report.yml - Form with required fields (description, reproduction steps)
  4. feature_request.md - Problem description + proposed solution format

Files Created

New Files Added (5):

  1. .github/SUPPORT.md - 31 lines
  2. .github/PULL_REQUEST_TEMPLATE.md - 28 lines
  3. .github/ISSUE_TEMPLATE/bug_report.yml - 85 lines
  4. .github/ISSUE_TEMPLATE/feature_request.md - 17 lines
  5. LICENSE.md - Verified existing file (no changes)

Fixes / Reference: #52

Test using WordPress Playground

The changes in this pull request can be previewed and tested using this WordPress Playground instance:

Click here to test this pull request.

@github-actions
Copy link

github-actions bot commented Oct 27, 2025

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: theaminuli <theaminuldev@git.wordpress.org>
Co-authored-by: jeffpaul <jeffpaul@git.wordpress.org>
Co-authored-by: iqbal-web <iqbal1hossain@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@theaminuli theaminuli changed the title Add Essential GitHub Repository Files (SUPPORT, PR Template, Issue Templates) Add Essential GitHub Repository Files (LICENSE, SUPPORT, PR Template, Issue Templates) Oct 27, 2025
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure we need this file, feels unnecessary on top of README.md and CONTRIBUTING.md. What's the thinking with adding in this file?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/WordPress/gutenberg/blob/trunk/.github/SUPPORT.md

Gutenberg also has SUPPORT.md file and

#42 also has several .md files

Copy link
Member Author

@theaminuli theaminuli Oct 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure we need this file, feels unnecessary on top of README.md and CONTRIBUTING.md. What's the thinking with adding in this file?

The main idea was to provide a clear support reference within the repository itself, so contributors and users can easily find where to get help without relying solely on the README or CONTRIBUTING files. It helps improve discoverability and maintain consistency across WordPress projects.

For example, the Gutenberg repository also includes a SUPPORT.md file for the same purpose.

@jeffpaul jeffpaul added this to the 0.1.0 milestone Oct 27, 2025
@jeffpaul jeffpaul added the [Type] Task Issues or PRs that have been broken down into an individual action to take label Oct 27, 2025
@theaminuli
Copy link
Member Author

All the mentioned issues have been resolved.
Thank you for your review and guidance. I really appreciate the feedback and support! @jeffpaul

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

Labels

[Type] Task Issues or PRs that have been broken down into an individual action to take

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants