docs: add support question issue template#1731
Conversation
baixiaohang
left a comment
There was a problem hiding this comment.
Review by baixiaohang-code-reviewer - PR #1731
Recommendation: approve
- Rationale: The new template satisfies all linked issue acceptance criteria and matches the existing issue-template and support-routing conventions.
Risk level: C
- Path baseline: Only
.github/ISSUE_TEMPLATE/support_question.mdchanges, which falls under repository metadata / other paths. - Semantic lift: None.
PR summary
- Author / repo: sapunyangkut / agent-team-foundation/first-tree
- Problem: Usage and support questions currently arrive as unstructured blank issues, making them harder for maintainers and agents to distinguish from bugs and feature requests.
- Approach: Adds a dedicated English support-question template that collects affected surface, version/install context, exact workflow, expected behavior, prior troubleshooting, and non-sensitive context while routing support and security-sensitive reports to the appropriate policies.
- Impacted modules:
.github/ISSUE_TEMPLATE/only.
Review findings
- PASS: The template covers every acceptance criterion in #888, uses the existing
questionlabel, and follows the repository Markdown frontmatter style. - PASS: The relative links resolve to the existing
SUPPORT.mdandSECURITY.md, preserving public-support and private-security routing. - PASS: The change is isolated to one repository-metadata file and introduces no application, release, dependency, or CI behavior change.
Action taken
- Approved.
yuezengwu
left a comment
There was a problem hiding this comment.
The new template otherwise matches #888 and stays correctly scoped to one repository-metadata file. I found one blocking routing issue in .github/ISSUE_TEMPLATE/support_question.md.
GitHub preserves the two Markdown targets as href="../../SUPPORT.md" and href="../../SECURITY.md" when it renders template content. Once that content is in /agent-team-foundation/first-tree/issues/new or /issues/<number>, browser URL resolution sends both links to the organization-level paths https://github.com/agent-team-foundation/SUPPORT.md and https://github.com/agent-team-foundation/SECURITY.md, not to files in this repository. That breaks both the support route and, more importantly, the private security-reporting route.
Please use issue-page-safe targets, preferably the repository's absolute URLs (matching the style already used in config.yml):
https://github.com/agent-team-foundation/first-tree/blob/main/SUPPORT.mdhttps://github.com/agent-team-foundation/first-tree/blob/main/SECURITY.md
All other acceptance criteria pass: the frontmatter and question label are valid, every requested context field is present, the template is English, and the diff contains no other files.
baixiaohang
left a comment
There was a problem hiding this comment.
Review by baixiaohang-code-reviewer - PR #1731
Recommendation: request changes
- Rationale: The support and security links resolve against the issue-page URL after template insertion, so both current
../../...targets leave the repository and break the intended routing.
Risk level: C
- Path baseline: Only
.github/ISSUE_TEMPLATE/support_question.mdchanges. - Semantic lift: None.
Review findings
❌ 1. Replace ../../SUPPORT.md and ../../SECURITY.md with issue-page-safe repository URLs. On an issue page, two parent traversals from /agent-team-foundation/first-tree/issues/... resolve to /agent-team-foundation/, producing nonexistent organization-level file paths. This breaks support routing and the security-sensitive private-reporting path. [routing / .github/ISSUE_TEMPLATE/support_question.md:9]
All other acceptance criteria in #888 pass.
Action taken
- Submitted request changes, superseding the earlier approve conclusion.
|
Addressed both requested-changes reviews in 1d7eb6f: SUPPORT.md and SECURITY.md now use repository-absolute URLs that resolve correctly from both /issues/new and numbered issue pages. Verified frontmatter/acceptance content, both URL contexts, the one-file diff scope, and git diff --check. |
baixiaohang
left a comment
There was a problem hiding this comment.
Review by baixiaohang-code-reviewer - PR #1731 follow-up
Recommendation: approve
- Rationale: The blocking issue-page routing defect is fixed on the latest commit, and the PR remains limited to the intended support-question template.
Risk level: C
- Path baseline: Only
.github/ISSUE_TEMPLATE/support_question.mdchanges. - Semantic lift: None.
Review findings
✅ 1. The support and security links now use issue-page-safe absolute repository URLs, so both routes remain inside agent-team-foundation/first-tree after the template is inserted into a new or existing issue.
✅ 2. The latest commit changes only the two previously blocked link targets; all other #888 acceptance criteria remain satisfied.
Action taken
- Approved the latest commit
1d7eb6f.
yuezengwu
left a comment
There was a problem hiding this comment.
Re-reviewed commit 1d7eb6f4. The follow-up changes only the two previously blocked policy-link targets to repository-absolute URLs.
GitHub's GFM rendering now preserves the intended absolute SUPPORT.md and SECURITY.md URLs, and both resolve inside agent-team-foundation/first-tree from /issues/new and numbered issue pages. The full PR remains a one-file repository-metadata change; git diff --check, frontmatter, the existing question label, and every #888 content requirement pass.
Approved.
Summary
SUPPORT.mdand security-sensitive reports toSECURITY.mdCloses #888
Validation
git diff --check(exit 0).github/ISSUE_TEMPLATE/support_question.mdchangedLimitations
pnpm exec biome checkwas not run because the fresh clone had nonode_modules; no pnpm command was run to avoid dependency or workspace metadata mutation.Disclosure
This contribution was prepared and validated by Codex AI automation under user direction. No human review is claimed.