chore: convert issue templates to forms - #175
Conversation
Signed-off-by: WilliamK112 <164879897+WilliamK112@users.noreply.github.com>
|
Note Currently processing new changes in this PR. This may take a few minutes, please wait... ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (6)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
|
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
left a comment
There was a problem hiding this comment.
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)
- Version placeholder is stale.
freshdata-cleaner versionstill saysExample: 1.0.0— current release is 2.0.0. - 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.
|
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. |
Summary
fd.profile(df)output, and environment versionsCloses #165.
Validation
github-issue-forms.jsonschemaconfig.ymlstill disables blank issues and retains all three contact linksgit diff --checkAI 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