Skip to content

chore(github): add a Discussions contact link to the issue templates - #103

Merged
mrsibe merged 1 commit into
mainfrom
chore/issue-template-contact-links
Sep 25, 2026
Merged

mrsibe merged 1 commit into
mainfrom
chore/issue-template-contact-links

Conversation

@mrsibe

@mrsibe mrsibe commented Sep 25, 2026 •

Copy link
Copy Markdown
Owner

What does this PR do?

Points the issue chooser at the Discussions Ideas category for feature requests and workflow pain points, so that feedback which is neither a bug report nor a fully-specified feature request has a home other than the issue tracker.

Why?

#11 was doing that job as an ordinary issue — a standing feedback thread with 10 comments of real user input, which is exactly the shape a Discussion is for. Discussions is now enabled, and #11 has been converted into #102 (all 10 comments carried over). But nothing in the issue chooser advertised the channel: a user opening "New issue" still sees only Bug Report, Feature Request and a blank issue.

The link also states the follow-through, because that is what makes Discussions trustworthy as an intake channel: approved ideas move into their own issue, with an owner, acceptance criteria and a milestone.

Linking the category rather than discussion #102 keeps this working as more threads are opened in Ideas.

Related issue

Related to #11 (now discussion #102)

What changed?

  • .github/ISSUE_TEMPLATE/config.yml — added one contact_links entry pointing at https://github.com/mrsibe/KnowNote/discussions/categories/ideas
  • Rewrote the blank_issues_enabled comment, which justified itself with a rationale that Discussions now partly answers
  • blank_issues_enabled itself is unchanged (true), so which templates are offered does not change

How was this tested?

  • Parsed the file and asserted blank_issues_enabled: true plus a single contact_links entry carrying exactly the name / url / about keys GitHub requires
  • npx prettier --check .github/ISSUE_TEMPLATE/config.yml — "All matched files use Prettier code style!"
  • Both …/discussions and …/discussions/categories/ideas return HTTP 200, and the Ideas category now contains discussion Feature requests & workflow pain points #102

Known limitation: GitHub renders this file when the chooser page is requested, and it reads it from the default branch — so the rendered chooser cannot be verified from this branch. Worth a glance at https://github.com/mrsibe/KnowNote/issues/new/choose after merge.

Screenshots / recordings

N/A — no application UI change.

Checklist

  • I have reviewed my own changes.
  • npm run typecheck passes. — not run: no TypeScript is touched. This PR changes one YAML config file under .github/
  • npm run build passes. — not run, same reason
  • I have tested the affected user workflow. — the YAML is schema-validated and the target URL resolves; the rendered chooser requires the merge
  • I have not included unrelated changes.
  • I have updated documentation when necessary. — no documentation describes the issue chooser

Desktop / build changes

  • Not applicable

Ideas and workflow pain points now have a channel that is not the issue tracker,
but nothing pointed to it. The issue chooser offered only "Bug Report",
"Feature Request" and a blank issue, so the feedback that #11 collects would still
have arrived as issues after Discussions was enabled.

The Ideas category is now linked from the chooser, with the same wording the
discussion itself uses, and it states what happens to an idea afterwards — it
moves into its own issue with an owner, acceptance criteria and a milestone. That
promise is the reason to route ideas here rather than through #11: an idea posted
as a discussion can be converted into tracked work without the author restating
it, which is not true of a comment buried in a long thread.

`blank_issues_enabled` stays true, and the comment is rewritten because its
original rationale — "plenty of feedback does not fit cleanly into bug or
feature" — is now partly answered by Discussions, while a blank issue remains the
right shape for a wrong claim in the README or a packaging surprise.

No change to which templates are offered.
@github-actions github-actions Bot added the skip-changelog Exclude from generated release notes label Sep 25, 2026
@mrsibe
mrsibe merged commit f604c8d into main Sep 25, 2026
5 checks passed
@mrsibe
mrsibe deleted the chore/issue-template-contact-links branch September 25, 2026 05:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip-changelog Exclude from generated release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant