Repository navigation
Refine Issue and Pull Request templates - #26
Open
huzaifaalmesbah wants to merge 2 commits into
Open
huzaifaalmesbah wants to merge 2 commits into
huzaifaalmesbah wants to merge 2 commits into
Conversation
- 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.
|
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 If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
.github/ISSUE_TEMPLATE/documentation.yml) to easily report issues or suggest improvements in docs, guides, and docblocks.Browser / Assistive technologyfield (critical for capturing screen readers like NVDA/VoiceOver or keyboard-only environments in an accessibility plugin).Accessibility Lab settings pageandBuild tools / CI.php-versionoptional to reduce friction for frontend/accessibility-only bug reports.readme.txttoREADME.md.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.Testing Instructions for Keyboard(standard from Gutenberg) to safeguard against UI accessibility regressions.npm run lint, manual testing, docs) as the essential maintenance checks requested in [Task]: Refine Pull Request and Issue Templates #15.Use of AI Toolsdisclosure 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?
.github/ISSUE_TEMPLATE/documentation.ymlwith GitHub Issue Forms syntax..github/ISSUE_TEMPLATE/bug_report.ymland.github/ISSUE_TEMPLATE/feature_request.yml..github/PULL_REQUEST_TEMPLATE.md.Testing Instructions
.github/ISSUE_TEMPLATE/documentation.ymland verify fields, labels, and checklists..github/ISSUE_TEMPLATE/bug_report.ymland.github/ISSUE_TEMPLATE/feature_request.yml..github/PULL_REQUEST_TEMPLATE.mdto verify the streamlined sections, the checklist, and AI disclosure placement.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.