Skip to content

docs(skill): add no-editorializing rule for written output#44

Merged
CybotTM merged 2 commits into
mainfrom
feat/no-editorializing-rule
Jul 1, 2026
Merged

docs(skill): add no-editorializing rule for written output#44
CybotTM merged 2 commits into
mainfrom
feat/no-editorializing-rule

Conversation

@CybotTM

@CybotTM CybotTM commented Jul 1, 2026

Copy link
Copy Markdown
Member

Adds a Critical Rule and references/no-editorializing.md: in release notes, PR/commit text and docs, state what a release does, not how good the work is — no self-praise or narrating expected results. Judged by tone (deletion / subject / voice tests), not a wordlist. SKILL.md kept under the 500-word limit by tightening reference descriptions. Mirrors netresearch/git-workflow-skill#83.

State what a release does, not how good the work is; no self-praise or
narrating expected results. Full rule in references/no-editorializing.md;
SKILL.md kept under 500 words by tightening reference descriptions.

Signed-off-by: Sebastian Mendel <info@sebastianmendel.de>
Copilot AI review requested due to automatic review settings July 1, 2026 11:33
@github-actions github-actions Bot added documentation Improvements or additions to documentation skill labels Jul 1, 2026
@github-actions

github-actions Bot commented Jul 1, 2026

Copy link
Copy Markdown

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request introduces a new reference document, no-editorializing.md, which establishes guidelines against self-praise and editorializing in project artifacts, and integrates these rules into SKILL.md. It also refines and simplifies several steps and references in SKILL.md. Feedback is provided regarding the removal of the -m flag from the git tag command in step 6, which could block non-interactive environments by prompting for an interactive editor and introduces a discrepancy with other referenced documentation.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread skills/github-release/SKILL.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Adds a new “No editorializing” critical rule to the GitHub release skill, with a dedicated reference document to guide tone in release-related written output (release notes, PR/commit text, and docs). Also trims/rewrites parts of SKILL.md to keep the core skill concise while linking to the new reference.

Changes:

  • Add a “No editorializing” critical rule and link it from SKILL.md.
  • Introduce references/no-editorializing.md with concrete tone-based tests and examples.
  • Tighten SKILL.md wording (including references list and parts of the release flow steps) to reduce verbosity.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
skills/github-release/SKILL.md Adds the new “No editorializing” critical rule and streamlines release-flow/reference wording.
skills/github-release/references/no-editorializing.md New reference doc defining and operationalizing the “no editorializing” guidance for written artifacts.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread skills/github-release/SKILL.md Outdated
Address review: keep 'git tag -s vX.Y.Z -m "vX.Y.Z"' (omitting -m opens an
editor and drops the annotated-tag convention); reference doc uses an H1 title.

Signed-off-by: Sebastian Mendel <info@sebastianmendel.de>
@sonarqubecloud

sonarqubecloud Bot commented Jul 1, 2026

Copy link
Copy Markdown

@CybotTM CybotTM merged commit 59b8005 into main Jul 1, 2026
24 of 26 checks passed
@CybotTM CybotTM mentioned this pull request Jul 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation skill

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants