Skip to content

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

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

docs(skill): add no-editorializing rule for written output#98
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 ## No editorializing note and references/no-editorializing.md: write what a change does, not how good or careful the work is — no narrating expected results or self-praise. Judged by tone (deletion / subject / voice tests), not a wordlist. SKILL.md kept under the 500-word limit by tightening a few triggers/prose. Mirrors netresearch/git-workflow-skill#83.

Copilot AI review requested due to automatic review settings July 1, 2026 11:29
@github-actions

github-actions Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Dependency Review

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

Scanned Files

None

@github-actions github-actions Bot added documentation Improvements or additions to documentation skill labels Jul 1, 2026

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

Copy link
Copy Markdown
Contributor

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 streamlines the 'When to Use' and 'Auto-merge Setup' sections in SKILL.md and introduces a new reference document, no-editorializing.md, which details guidelines for maintaining an objective tone in written artifacts. Feedback suggests updating the main heading of the new reference document to a level 1 heading (#) for proper Markdown structure and accessibility.

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-project/references/no-editorializing.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 explicit guidance to the GitHub Project Skill documentation to avoid “editorializing” (writing about how good/careful work is rather than what it does), and links that guidance as a first-class reference within the skill docs. This fits the repo’s role as a set of reusable, opinionated (but actionable) GitHub configuration/workflow references.

Changes:

  • Tightens/shortens the “When to Use” and “Auto-merge Setup” bullets in SKILL.md to keep the document concise.
  • Adds a new “No editorializing” section to SKILL.md and links to a dedicated reference page.
  • Introduces references/no-editorializing.md with concrete tone-based tests and examples.

Reviewed changes

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

File Description
skills/github-project/SKILL.md Refines the skill’s quick guidance and adds an explicit “No editorializing” section + reference link.
skills/github-project/references/no-editorializing.md New reference document defining and operationalizing the “no editorializing” writing rule.

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

Comment thread skills/github-project/SKILL.md Outdated
Comment thread skills/github-project/references/no-editorializing.md
State what a change does, not how good or careful the work is; no narrating
expected results or self-praise. Full rule in references/no-editorializing.md;
SKILL.md kept under the 500-word limit by tightening a few triggers/prose.

Signed-off-by: Sebastian Mendel <info@sebastianmendel.de>
@CybotTM CybotTM force-pushed the feat/no-editorializing-rule branch from 5a16d0a to a216a4a Compare July 1, 2026 11:59
Address review: standalone reference doc starts with H1 (contra- -> counter-
reaction); keep the 'Fork PR merge base' trigger consistent with the reference table.

Signed-off-by: Sebastian Mendel <info@sebastianmendel.de>
@CybotTM CybotTM enabled auto-merge July 1, 2026 12:39
@sonarqubecloud

sonarqubecloud Bot commented Jul 1, 2026

Copy link
Copy Markdown

@CybotTM CybotTM merged commit f57a675 into main Jul 1, 2026
18 checks passed
@CybotTM CybotTM deleted the feat/no-editorializing-rule branch July 1, 2026 12:42
@CybotTM CybotTM mentioned this pull request Jul 1, 2026
CybotTM added a commit that referenced this pull request Jul 1, 2026
Patch release.

- No-editorializing rule for PR/issue/comment text: a `## No
editorializing` note plus `references/no-editorializing.md`. (#98)

Tag v2.15.5 after merge to publish.
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