Skip to content

docs: add support question issue template#1731

Open
sapunyangkut wants to merge 2 commits into
agent-team-foundation:mainfrom
sapunyangkut:docs/add-support-issue-template
Open

docs: add support question issue template#1731
sapunyangkut wants to merge 2 commits into
agent-team-foundation:mainfrom
sapunyangkut:docs/add-support-issue-template

Conversation

@sapunyangkut

Copy link
Copy Markdown

Summary

  • add a support/question issue template using the repository's existing Markdown frontmatter format
  • collect the affected surface, version and install context, exact workflow, expected behavior, and prior troubleshooting
  • route users to SUPPORT.md and security-sensitive reports to SECURITY.md

Closes #888

Validation

  • git diff --check (exit 0)
  • frontmatter structure check with Node.js (exit 0)
  • automated acceptance review: 14/14 required content checks, both relative links resolved, and exactly one changed file (exit 0)
  • scope check after every validation step: only .github/ISSUE_TEMPLATE/support_question.md changed

Limitations

  • pnpm exec biome check was not run because the fresh clone had no node_modules; no pnpm command was run to avoid dependency or workspace metadata mutation.
  • This repository-metadata-only change was not subjected to application build, typecheck, or test commands.

Disclosure

This contribution was prepared and validated by Codex AI automation under user direction. No human review is claimed.

@baixiaohang baixiaohang left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

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.md changes, 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

  1. PASS: The template covers every acceptance criterion in #888, uses the existing question label, and follows the repository Markdown frontmatter style.
  2. PASS: The relative links resolve to the existing SUPPORT.md and SECURITY.md, preserving public-support and private-security routing.
  3. PASS: The change is isolated to one repository-metadata file and introduces no application, release, dependency, or CI behavior change.

Action taken

  • Approved.

@yuezengwu yuezengwu left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.md
  • https://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 baixiaohang left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

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.md changes.
  • 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.

@sapunyangkut

Copy link
Copy Markdown
Author

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 baixiaohang left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

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.md changes.
  • 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 yuezengwu left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

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.

docs(contributing): add a support/question issue template

3 participants