docs: document auto-applied attribution for source descriptions#1752
docs: document auto-applied attribution for source descriptions#1752ded-furby wants to merge 2 commits into
Conversation
|
@ded-furby please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
|
bindsi
left a comment
There was a problem hiding this comment.
Automated review (bindsi batch). Clean documentation update documenting that attribution suffixes are now auto-applied by tooling rather than manually included in source frontmatter. Both ai-artifacts-common.md and skills.md are updated consistently — description format guidance, examples, and the recognized metadata examples all drop the suffix. Aligns with the sibling attribution-strip PRs (#1721–#1724). LGTM.
bindsi
left a comment
There was a problem hiding this comment.
Automated batch review: no actionable findings.
|
Approving the convention change — omitting the attribution suffix from source One accuracy fix before/after merge: the wording says distribution/generation tooling appends attribution automatically to generated outputs. That isn't what the tooling does. The only suffix-handling code path strips the suffix:
So a source file that omits the suffix simply produces output with no per-artifact suffix (byte-identical to today, since tooling already strips — consistent with #1711's "verified byte-identical post-change" note). Describing this as "appended automatically" will mislead future contributors into thinking the suffix reappears downstream. Suggested rewording:
And drop (or reword) the "Generated outputs append the attribution suffix automatically…" line to "Generation tooling strips any attribution suffix from descriptions." Non-blocking from my side — happy to see the convention land; just don't ship the "appends" phrasing as-is. |
bindsi
left a comment
There was a problem hiding this comment.
Approving. Clean documentation update: source AI-artifact/skill description frontmatter now omits the attribution suffix, with attribution carried by the collection/plugin footer and any leftover suffix stripped by generation tooling. ai-artifacts-common.md and skills.md are updated consistently (guidance, examples, recognized-metadata example), aligning with the merged attribution-strip PRs (#1721–#1724). No issues.
Codecov Report✅ All modified and coverable lines are covered by tests.
Additional details and impacted files@@ Coverage Diff @@
## main #1752 +/- ##
==========================================
- Coverage 85.33% 78.00% -7.33%
==========================================
Files 90 84 -6
Lines 13004 13764 +760
==========================================
- Hits 11097 10737 -360
- Misses 1907 3027 +1120
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
Summary
Closes #1718.
Validation