Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 2, 2025

README contained conflicting statements claiming tasks are matched by task_name frontmatter field. The actual code matches by filename (sans .md extension).

Changes

  • Line 107: "Find a task file with task_name: fix-bug" → "Find a task file named fix-bug.md"
  • Line 138: "<task-name> is the value of the task_name field" → "corresponds to the filename"
  • Line 148: Removed incorrect reference to requiring task_name in frontmatter
  • Line 168: "matching task_name in frontmatter" → "matches filename without .md extension"
  • Lines 239-241: "filename doesn't matter - only task_name is used" → "matched by filename, task_name is optional metadata"

Code reference

From pkg/codingcontext/context.go:

// Match by filename (without .md extension)
baseName := strings.TrimSuffix(filepath.Base(path), ".md")
if baseName != taskName {
    return nil
}
Original prompt

There's a comment in the README that tasks are found based on frontmatter. This seems incorrect to me. Can you please check against the code?


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Tasks are matched by filename (not .md extension), not by task_name
in frontmatter. The task_name field is optional metadata.

Fixes:
- Line 107: "Find a task file with task_name: fix-bug" -> "Find a task file named fix-bug.md"
- Line 138: "The <task-name> is the value of the task_name field" -> "corresponds to the filename"
- Line 148: Removed incorrect reference to task_name in frontmatter
- Line 168: "matching task_name in frontmatter" -> "matches filename without .md extension"
- Lines 239-241: Removed claim that "filename doesn't matter" and "task_name is required"

Co-authored-by: alexec <1142830+alexec@users.noreply.github.com>
@alexec alexec marked this pull request as ready for review December 2, 2025 16:54
@alexec alexec enabled auto-merge (squash) December 2, 2025 16:54
@alexec alexec merged commit 5f9b9c7 into main Dec 2, 2025
2 checks passed
@alexec alexec deleted the copilot/fix-readme-comment branch December 2, 2025 16:55
Copilot AI changed the title [WIP] Fix incorrect README comment about task discovery Fix incorrect README documentation about task file matching Dec 2, 2025
Copilot AI requested a review from alexec December 2, 2025 16:55
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