Skip to content

Polish the consumer-repo wording in the update-copyright skill#32

Open
alexander-yevsyukov wants to merge 1 commit into
masterfrom
polish-update-copyright-doc
Open

Polish the consumer-repo wording in the update-copyright skill#32
alexander-yevsyukov wants to merge 1 commit into
masterfrom
polish-update-copyright-doc

Conversation

@alexander-yevsyukov

Copy link
Copy Markdown
Contributor

What

Wording-only follow-up to #31, applying the documentation-review nits that were noted there and left for a separate pass. All changes are in skills/update-copyright/SKILL.md; no behavior changes.

  • Sentence-case the H1 (# Copyright update) per the documentation guideline.
  • Explain the config:replaces mechanism instead of citing it as bare jargon, using the defining terminology from config's migrate script ("directive") and a restrictive that-clause: "variants that replace a distributed workflow via a config:replaces directive and so ship under a different basename".
  • Add a second example before "etc." (buildSrc/, gradle.properties, etc.) — "etc." after a single item promised a list that wasn't there.
  • Name update_copyright.py explicitly as the holder of the exclusion set; the previous "update the script's exclusions" read as if migrate were the antecedent.
  • Rewrap the affected paragraphs to the file's ~80-column style (no line exceeds the 100 limit; no runt lines).

Verification

  • review-docs reviewed the diff: APPROVE, no Must-fix or Should-fix items. Its one optional nit (marker → directive) is folded into this PR.
  • Every factual claim was verified against the sources: gradle.properties is in the script's CONFIG_DISTRIBUTED_ROOT_FILES, and config/migrate documents the config:replaces directive with variants under distinct basenames.
  • Markdown-only change: no build applies; version gate not applicable (no root version.gradle.kts).

🤖 Generated with Claude Code

Apply the documentation-review nits noted on PR #31 and left for
follow-up:

- Sentence-case the H1 per the documentation guideline.
- Explain the `config:replaces` marker instead of citing it as bare
  jargon, and make the relative clause restrictive.
- Add a second example before "etc.".
- Name `update_copyright.py` as the holder of the exclusions; "the
  script's exclusions" read as if `migrate` were meant.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings July 10, 2026 18:42

Copilot AI 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.

Pull request overview

Documentation-only refinement to the update-copyright skill, improving clarity and consistency around how consumer repositories and config-distributed files are described (no script/behavior changes).

Changes:

  • Sentence-cases the skill H1 (“Copyright update”) to match documentation style.
  • Clarifies the config:replaces concept by describing it as a directive that produces replacement workflow variants with different basenames.
  • Improves wording and wrapping in the “config-distributed files” section (adds an additional example and points to update_copyright.py as the exclusion source).

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

@alexander-yevsyukov alexander-yevsyukov self-assigned this Jul 10, 2026
@alexander-yevsyukov alexander-yevsyukov moved this to 🏗 In progress in v2.0 Jul 10, 2026
@alexander-yevsyukov alexander-yevsyukov moved this from 🏗 In progress to In Review in v2.0 Jul 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In Review

Development

Successfully merging this pull request may close these issues.

2 participants