Skip to content

docs: document auto-applied attribution for source descriptions #1752

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ded-furby wants to merge 2 commits into
base: main
Choose a base branch
from
+11 −11
Open

docs: document auto-applied attribution for source descriptions #1752

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
552a706
docs: clarify auto-applied attribution suffix
ded-furby Jun 1, 2026
5b136a1
docs: clarify attribution suffix handling
ded-furby Jun 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/contributing/ai-artifacts-common.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
---
title: 'AI Artifacts Common Standards'
description: 'Common standards and quality gates for all AI artifact contributions to hve-core'
Expand Down Expand Up @@ -848,13 +848,13 @@

## Attribution Requirements

All AI artifacts MUST include attribution as a suffix in the frontmatter `description` field:
Source AI artifact files MUST omit attribution from the frontmatter `description` field. Generation tooling strips any attribution suffix from source descriptions, so omitting it keeps generated outputs byte-identical while reclaiming Copilot context-index tokens:

```yaml
description: 'Tests prompt files in a sandbox environment - Brought to you by microsoft/hve-core'
description: 'Tests prompt files in a sandbox environment'
```

Format: `- Brought to you by organization/repository-name` appended to the description value.
Distribution-level attribution is carried by the collection or plugin footer (for example, `> Source: microsoft/hve-core`), not by per-artifact description suffixes.

Skill files (`SKILL.md`) additionally include a blockquote attribution footer as the last line of body content:

Expand Down
16 changes: 8 additions & 8 deletions docs/contributing/skills.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,18 +99,18 @@ The `scripts/` directory is **optional**. When present, it **MUST** contain at l

**`description`** (string, MANDATORY)

| Property | Value |
|----------|------------------------------------------------------------------------------------------------------------|
| Purpose | Concise explanation of skill functionality |
| Format | Single sentence ending with attribution |
| Example | `'Video-to-GIF conversion skill with FFmpeg two-pass optimization - Brought to you by microsoft/hve-core'` |
| Property | Value |
|----------|---------------------------------------------------------------------------------------------------------|
| Purpose | Concise explanation of skill functionality |
| Format | Single sentence without the attribution suffix in source frontmatter; generation tooling strips any suffix from descriptions |
| Example | `'Video-to-GIF conversion skill with FFmpeg two-pass optimization'` |

### Frontmatter Example

```yaml
---
name: video-to-gif
description: 'Video-to-GIF conversion skill with FFmpeg two-pass optimization - Brought to you by microsoft/hve-core'
description: 'Video-to-GIF conversion skill with FFmpeg two-pass optimization'
---
```

Expand Down Expand Up @@ -194,7 +194,7 @@ Recognized metadata fields:
```yaml
---
name: pr-reference
description: 'Generate PR reference XML files with commit history and diffs for pull request workflows - Brought to you by microsoft/hve-core'
description: 'Generate PR reference XML files with commit history and diffs for pull request workflows'
user-invocable: true
disable-model-invocation: false
argument-hint: "[--base-branch=origin/main] [--exclude-markdown]"
Expand All @@ -208,7 +208,7 @@ This example demonstrates a skill configured for both automatic semantic loading
```yaml
---
name: owasp-llm
description: 'OWASP Top 10 for LLM Applications (2025) vulnerability knowledge base - Brought to you by microsoft/hve-core'
description: 'OWASP Top 10 for LLM Applications (2025) vulnerability knowledge base'
license: CC-BY-SA-4.0
user-invocable: false
metadata:
Expand Down
Loading