Skip to content

chore: convert issue templates to forms - #175

Merged
kevincostner17 merged 1 commit into
FreshCode-Org:mainfrom
WilliamK112:agent/issue-forms
Aug 12, 2026
Merged

chore: convert issue templates to forms#175
kevincostner17 merged 1 commit into
FreshCode-Org:mainfrom
WilliamK112:agent/issue-forms

Conversation

@WilliamK112

@WilliamK112 WilliamK112 commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Summary

  • replace the bug, feature, and documentation Markdown templates with GitHub issue forms
  • require actionable bug evidence: a minimal reproduction, fd.profile(df) output, and environment versions
  • require the affected page or file for documentation reports
  • preserve each template's title prefix/default label and leave the existing chooser contact links unchanged

Closes #165.

Validation

  • validated all three forms against SchemaStore's github-issue-forms.json schema
  • verified every input ID and label is unique
  • verified the required bug and documentation fields programmatically
  • verified config.yml still disables blank issues and retains all three contact links
  • git diff --check

AI usage

I used an AI coding assistant to help translate the existing Markdown templates and check the result against GitHub's documented issue-form schema. I manually reviewed the complete diff and ran the validation above.

Summary by CodeRabbit

  • Chores
    • Replaced legacy issue templates with structured GitHub issue forms.
    • Added guided forms for reporting bugs, documentation problems, and feature requests.
    • Forms now collect relevant details such as reproduction steps, environment information, proposed solutions, and supporting context.
    • Added appropriate labels, title prefixes, required fields, and optional guidance.

Signed-off-by: WilliamK112 <164879897+WilliamK112@users.noreply.github.com>
@coderabbitai

coderabbitai Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 6e1803c4-bdcb-4eef-b366-2c0f2e8d39c7

📥 Commits

Reviewing files that changed from the base of the PR and between f4cf5d8 and 2182f71.

📒 Files selected for processing (6)
  • .github/ISSUE_TEMPLATE/bug_report.md
  • .github/ISSUE_TEMPLATE/bug_report.yml
  • .github/ISSUE_TEMPLATE/documentation.md
  • .github/ISSUE_TEMPLATE/documentation.yml
  • .github/ISSUE_TEMPLATE/feature_request.md
  • .github/ISSUE_TEMPLATE/feature_request.yml
 ____________________________
< The OG: Original Grepster. >
 ----------------------------
  \
   \   (\__/)
       (•ㅅ•)
       /   づ
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@WilliamK112
WilliamK112 marked this pull request as ready for review August 12, 2026 09:31
@strix-security

Copy link
Copy Markdown
Contributor

Strix is installed on this repository, but we couldn't run this PR security review because this workspace's trial has ended. Add a card to resume code reviews here.

So far, Strix has reviewed 36 pull requests, surfaced 3 security issues (1 critical/high) and blocked 1 risky merge across this workspace.

@kevincostner17 kevincostner17 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.

Verdict: Valid — approve

Checked against #165.

Acceptance criteria

Criterion Status
Forms replace Markdown templates Pass.md deleted, .yml added for bug / feature / docs
Required fields block empty submission Pass — bug: description, repro, expected, profile, OS, Python, pandas, freshdata; docs: page/file + problem
config.yml contact links unchanged Pass — Discussions, docs, security advisory still present; blank_issues_enabled: false

What’s good

  • Bug form actually enforces the evidence the old Markdown template only asked for (repro + fd.profile(df) + versions).
  • Title prefixes ([BUG], [DOCS], [ENH]) and labels preserved.
  • Feature form keeps alternatives/context optional, which is the right bar.
  • CI green; no runtime code.

Nits (non-blocking)

  1. Version placeholder is stale. freshdata-cleaner version still says Example: 1.0.0 — current release is 2.0.0.
  2. Profile-output is required for every bug. That matches #165, but it will block CLI / install / import reports where fd.profile(df) doesn’t apply. Fine for now; consider a “N/A if not a DataFrame bug” hint in the description later.

Good to merge.

@kevincostner17

Copy link
Copy Markdown
Contributor

Thanks for this, @WilliamK112 — really appreciate the follow-up after #174.

The issue forms are a clear upgrade: required repro + profile + versions will make bug reports much easier to act on. Nice, careful conversion of the old templates. Looking forward to more from you.

@kevincostner17
kevincostner17 merged commit a3fc12d into FreshCode-Org:main Aug 12, 2026
16 checks passed
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.

tooling: convert issue templates to YAML issue forms (enforce required fields)

2 participants