Skip to content

docs(readme): fix truncated Contributing-section link#2

Merged
PBNZ merged 1 commit intomainfrom
fix/readme-truncated-contributing-link
Apr 18, 2026
Merged

docs(readme): fix truncated Contributing-section link#2
PBNZ merged 1 commit intomainfrom
fix/readme-truncated-contributing-link

Conversation

@PBNZ
Copy link
Copy Markdown
Owner

@PBNZ PBNZ commented Apr 18, 2026

Problem

The Contributing section of README.md ended mid-URL. Line 66 was literally:

See [CONTRIBUTING.md](./CONTRIBUTING.md). All changes to Newton's behaviour go through edits to the canonical [plugins/newton/skills/newton/SKILL.md](./plugins/new

— no closing ), no rest of the URL, no trailing newline. GitHub rendered the unclosed link as literal text, so the canonical-SKILL pointer wasn't a working anchor.

Fix

Restore the full link target ([plugins/newton/skills/newton/SKILL.md](./plugins/newton/skills/newton/SKILL.md)) and finish the sentence by noting that the surface-specific files under ool-rules/ regenerate from the canonical SKILL.md via scripts/generate-rule-files.py. That continuation mirrors the explanation already on line 35, so the README is now internally consistent about what's canonical and what's generated.

Scope

  • One file (README.md).
  • No version bump — README-only doc fix.
  • No CHANGELOG entry needed — typo/truncation repair below the noise floor of Unreleased notes.

Verification

  • git diff confirms a single-line replacement, +1/-1.
  • File now ends with a newline.
  • Link targets a path that exists in the tree (plugins/newton/skills/newton/SKILL.md).

Line 66 of README.md was truncated mid-URL — the canonical SKILL.md link was cut off after './plugins/new', leaving an unclosed markdown link that GitHub rendered as literal text instead of an anchor. The file also had no trailing newline.

Restores the full link target ('./plugins/newton/skills/newton/SKILL.md') and finishes the sentence by noting that the surface-specific files under tool-rules/ regenerate from the canonical SKILL.md via scripts/generate-rule-files.py — mirroring the explanation already given on line 35.
Copilot AI review requested due to automatic review settings April 18, 2026 15:20
@PBNZ PBNZ merged commit b162f29 into main Apr 18, 2026
3 checks passed
@PBNZ PBNZ deleted the fix/readme-truncated-contributing-link branch April 18, 2026 15:21
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Fixes a truncated link in the README’s Contributing section so GitHub renders the canonical SKILL.md reference correctly and the section ends cleanly.

Changes:

  • Restores the full Markdown link to plugins/newton/skills/newton/SKILL.md.
  • Completes the sentence to match existing README guidance: tool-rules/ files are generated from SKILL.md via scripts/generate-rule-files.py.
  • Ensures the file ends with a trailing newline.

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

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants