Skip to content

chore: remind agents to use Simplified Technical English in PR and issue templates - #1987

Open
zoomote[bot] wants to merge 4 commits into
mainfrom
chore/ste-template-reminders
Open

zoomote[bot] wants to merge 4 commits into
mainfrom
chore/ste-template-reminders

Conversation

@zoomote

@zoomote zoomote Bot commented Oct 10, 2026 •

Copy link
Copy Markdown
Contributor

Related GitHub Issue

Closes: #1986

Description

Adds a Simplified Technical English (STE) reminder to every PR and issue template so agents and contributors write titles and descriptions in clear, simple language.

  • Pull request template: STE note in the header comment and a new "Writing Style" item in the pre-submission checklist.
  • Markdown issue templates (bug report, feature request, add provider model): STE reminder as an HTML comment at the top of the body.
  • YAML issue forms (bug report, enhancement request, marketplace feedback): STE reminder line in the intro markdown block.
  • The reminder wording is identical in all seven templates, including "Keep the title short and specific."
  • No other template content changed.

Test Procedure

  • All three YAML issue forms parse with PyYAML and pass GitHub issue-form schema sanity checks (name/body present, valid element types, unique ids, required labels, non-empty dropdown options, boolean required flags). Zero violations.
  • Diffed all four Markdown files against main: the only changes are the intended STE reminder lines. No unexpected diff lines.
  • The Writing Style checklist checkbox starts unchecked (- [ ]).
  • Markdown templates render unchanged because the reminder is inside an HTML comment.
  • Not exercised: GitHub's live issue-form rendering/preview (read-only validation).

Pre-Submission Checklist

  • Issue Linked: This PR is linked to an approved GitHub Issue (see "Related GitHub Issue" above).
  • Scope: My changes are focused on the linked issue (one major feature/fix per PR).
  • Self-Review: I have performed a thorough self-review of my code.
  • Writing Style: The PR title and description use Simplified Technical English (short sentences, plain words, active voice, one idea per sentence).
  • Testing: New and/or updated tests have been added to cover my changes (if applicable).
  • Documentation Impact: I have considered if my changes require documentation updates (see "Documentation Updates" section below).
  • Contribution Guidelines: I have read and agree to the Contributor Guidelines.

Documentation Updates

  • No documentation updates are required.

@coderabbitai

coderabbitai Bot commented Oct 10, 2026 •

Copy link
Copy Markdown
Contributor

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration
  • Configuration used: Repository: Zoo-Code-Org/Zoo-Code/.coderabbit.yaml
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: cecd88e0-6d21-41ce-9591-986988fc556e

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@codecov

codecov Bot commented Oct 10, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@github-actions

github-actions Bot commented Oct 10, 2026 •

Copy link
Copy Markdown
Contributor

Review status

This PR was opened by an automated account. A human maintainer must verify the change intent, provenance, and validation before merging.

Current step: Required CI passed. Waiting for automated review of the latest commit.

If automated review does not start, a maintainer must restart it.

Review-state labels are managed by this workflow; do not edit them manually. community-approved is managed the same way — do not add or remove it manually. It signals a fresh community code approval for the current head as an advisory priority only; maintainer review is still required.

@github-actions github-actions Bot added coderabbit-review-active Required CI passed; CodeRabbit review is active awaiting-coderabbit Waiting for CodeRabbit to approve the latest commit labels Oct 10, 2026
@github-actions github-actions Bot added coderabbit-review-active Required CI passed; CodeRabbit review is active awaiting-coderabbit Waiting for CodeRabbit to approve the latest commit and removed coderabbit-review-active Required CI passed; CodeRabbit review is active awaiting-coderabbit Waiting for CodeRabbit to approve the latest commit labels Oct 10, 2026
@github-actions github-actions Bot added coderabbit-review-active Required CI passed; CodeRabbit review is active awaiting-coderabbit Waiting for CodeRabbit to approve the latest commit and removed coderabbit-review-active Required CI passed; CodeRabbit review is active awaiting-coderabbit Waiting for CodeRabbit to approve the latest commit labels Oct 10, 2026

This branch has not been deployed

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

Labels

awaiting-coderabbit Waiting for CodeRabbit to approve the latest commit coderabbit-review-active Required CI passed; CodeRabbit review is active

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Remind agents to use Simplified Technical English in PR and issue templates

1 participant