Skip to content

Refine Issue and Pull Request templates - #26

Open
huzaifaalmesbah wants to merge 2 commits into
WordPress:mainfrom
huzaifaalmesbah:change/refine-issue-and-pr-templates
Open

huzaifaalmesbah wants to merge 2 commits into
WordPress:mainfrom
huzaifaalmesbah:change/refine-issue-and-pr-templates

Conversation

@huzaifaalmesbah

@huzaifaalmesbah huzaifaalmesbah commented Sep 18, 2026 •

Copy link
Copy Markdown
Member

What?

Closes #15

This PR standardizes and refines the repository's GitHub Issue templates and Pull Request template to match the plugin's actual architecture, improve report quality, and reduce contributor friction.

Key improvements:

  • Documentation Issue Template: Added a new issue template (.github/ISSUE_TEMPLATE/documentation.yml) to easily report issues or suggest improvements in docs, guides, and docblocks.
  • Bug Report Template:
    • Added a dedicated Browser / Assistive technology field (critical for capturing screen readers like NVDA/VoiceOver or keyboard-only environments in an accessibility plugin).
    • Updated module dropdown options to match the module names shown in Settings, and added Accessibility Lab settings page and Build tools / CI.
    • Made php-version optional to reduce friction for frontend/accessibility-only bug reports.
  • Feature Request Template:
    • Fixed broken link reference from readme.txt to README.md.
    • Replaced the area options with evergreen categories (New feature, New experiment, Block validation rule, Enhancement to an existing module). Track (Core/Practical) is kept separate, since the README notes either bucket can live on either track.
  • Pull Request Template:
    • Added Testing Instructions for Keyboard (standard from Gutenberg) to safeguard against UI accessibility regressions.
    • Removed the 7-line sample changelog block.
    • Kept a short checklist (contributing guidelines, npm run lint, manual testing, docs) as the essential maintenance checks requested in [Task]: Refine Pull Request and Issue Templates #15.
    • Placed the Use of AI Tools disclosure guidance at the end of the template.

Why?

As outlined in #15, the initial templates lacked key accessibility testing instructions, had broken references (e.g. readme.txt), lacked a dedicated documentation template, and included unnecessary boilerplate in the PR template. Refining these templates provides clearer guidance for contributors and helps maintainers triage issues more effectively.

How?

  • Created .github/ISSUE_TEMPLATE/documentation.yml with GitHub Issue Forms syntax.
  • Updated .github/ISSUE_TEMPLATE/bug_report.yml and .github/ISSUE_TEMPLATE/feature_request.yml.
  • Streamlined .github/PULL_REQUEST_TEMPLATE.md.
  • Validated all YAML templates with Python's YAML parser to ensure zero syntax errors.

Testing Instructions

  1. Review .github/ISSUE_TEMPLATE/documentation.yml and verify fields, labels, and checklists.
  2. Review .github/ISSUE_TEMPLATE/bug_report.yml and .github/ISSUE_TEMPLATE/feature_request.yml.
  3. Review .github/PULL_REQUEST_TEMPLATE.md to verify the streamlined sections, the checklist, and AI disclosure placement.
  4. Verify all YAML files are syntax-valid.

Testing Instructions for Keyboard

N/A (This PR only touches GitHub configuration files; no UI code is modified).

Screenshots or screencast

N/A

Use of AI Tools

AI assistance: Yes
Tool(s): Google Antigravity
Used for: Drafting template files, validating YAML syntax, and structuring the PR description. Reviewed and refined before submission.
Tool(s): Claude Code
Used for: Review follow-ups (module names, feature area options, restoring the checklist). Reviewed before pushing.

- Add documentation issue template.
- Refine bug report template with Assistive Technology field, updated module options, and optional PHP version.
- Refine feature request template with updated README reference and clearer area categories.
- Streamline PR template with Keyboard testing instructions, remove boilerplate noise, and place AI disclosure at the end.

Fixes WordPress#15
Use the module names shown in Settings, keep Feature/Experiment
separate from Track as the README describes, and bring back a short
PR checklist (lint, testing, docs) as requested in WordPress#15.
@github-actions

github-actions Bot commented Oct 9, 2026

Copy link
Copy Markdown

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: huzaifaalmesbah <[email protected]>
Co-authored-by: troychaplin <[email protected]>

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

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.

[Task]: Refine Pull Request and Issue Templates

1 participant