From 2182f715550e15549a952baf8280216700be3e28 Mon Sep 17 00:00:00 2001 From: WilliamK112 <164879897+WilliamK112@users.noreply.github.com> Date: Wed, 12 Aug 2026 17:23:58 +0800 Subject: [PATCH] chore: convert issue templates to forms Signed-off-by: WilliamK112 <164879897+WilliamK112@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug_report.md | 33 --------- .github/ISSUE_TEMPLATE/bug_report.yml | 82 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/documentation.md | 20 ------ .github/ISSUE_TEMPLATE/documentation.yml | 33 +++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ------ .github/ISSUE_TEMPLATE/feature_request.yml | 39 ++++++++++ 6 files changed, 154 insertions(+), 73 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/documentation.md create mode 100644 .github/ISSUE_TEMPLATE/documentation.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 2c63cac8..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve freshdata -title: '[BUG] ' -labels: bug -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior. Please provide a minimal self-contained Python script with a sample DataFrame if possible: -```python -import pandas as pd -import freshdata as fd - -df = pd.DataFrame(...) -fd.clean(df) -``` - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Profile/Report Payload (if applicable)** -If you can, please include the output of `fd.profile(df)` or `report.to_dict()`. - -**Environment (please complete the following information):** -- OS: [e.g. macOS, Ubuntu, Windows] -- Python Version [e.g. 3.9, 3.12] -- Pandas Version [e.g. 2.2.0, 3.0.3] -- freshdata-cleaner Version [e.g. 1.0.0] diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..232522c8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,82 @@ +name: Bug report +description: Create a report to help us improve freshdata +title: "[BUG] " +labels: + - bug +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to report a bug. Please search existing issues first and remove any sensitive data from examples or profile output. + + - type: textarea + id: description + attributes: + label: Describe the bug + description: Clearly describe what went wrong. + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: Minimal reproduction + description: Provide a self-contained Python script with a small sample DataFrame that reproduces the problem. + placeholder: | + import pandas as pd + import freshdata as fd + + df = pd.DataFrame(...) + fd.clean(df) + render: python + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected behavior + description: Describe what you expected to happen instead. + validations: + required: true + + - type: textarea + id: profile-output + attributes: + label: Profile output + description: Paste the output of `fd.profile(df)` for the minimal reproduction. Remove any sensitive data first. + render: text + validations: + required: true + + - type: input + id: operating-system + attributes: + label: Operating system + placeholder: "Example: macOS 15, Ubuntu 24.04, or Windows 11" + validations: + required: true + + - type: input + id: python-version + attributes: + label: Python version + placeholder: "Example: 3.12.8" + validations: + required: true + + - type: input + id: pandas-version + attributes: + label: pandas version + placeholder: "Example: 2.2.3" + validations: + required: true + + - type: input + id: freshdata-version + attributes: + label: freshdata-cleaner version + placeholder: "Example: 1.0.0" + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md deleted file mode 100644 index 51f71963..00000000 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Documentation issue -about: Report a mistake, gap, or unclear section in the docs, README, or examples -title: '[DOCS] ' -labels: documentation -assignees: '' - ---- - -**Where** -Link to the page or file (e.g. a https://freshcode-org.github.io/freshdata/ URL, -`README.md`, or an `examples/` script) and the section heading. - -**What is wrong or missing** -A clear description of the problem: incorrect statement, code snippet that -doesn't run, broken link, missing explanation, outdated API, etc. - -**Suggested fix (optional)** -If you already know what the text or snippet should say, propose it here — -small doc fixes make great first PRs. diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 00000000..5ce00f56 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,33 @@ +name: Documentation issue +description: Report a mistake, gap, or unclear section in the docs, README, or examples +title: "[DOCS] " +labels: + - documentation +body: + - type: markdown + attributes: + value: | + Thanks for helping improve the documentation. Please search existing issues before submitting a report. + + - type: input + id: location + attributes: + label: Page or file + description: Link to the documentation page or name the repository file and section heading. + placeholder: "Example: https://freshcode-org.github.io/freshdata/... or README.md — Quickstart" + validations: + required: true + + - type: textarea + id: problem + attributes: + label: What is wrong or missing? + description: Describe the incorrect statement, broken example or link, missing explanation, outdated API, or other documentation problem. + validations: + required: true + + - type: textarea + id: suggested-fix + attributes: + label: Suggested fix + description: If you know what the text or example should say, propose it here. This field is optional. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 21ccc6a8..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Propose a new feature, cleaning step, or heuristic for the cleaning engine -title: '[ENH] ' -labels: enhancement -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. E.g. "I want to clean dates in XYZ custom format..." - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. What are the rules and heuristics for this new cleaning step? - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or workarounds you've considered. - -**Additional context** -Add any other context or code examples about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..d59f9341 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,39 @@ +name: Feature request +description: Propose a new feature, cleaning step, or heuristic for the cleaning engine +title: "[ENH] " +labels: + - enhancement +body: + - type: markdown + attributes: + value: | + Thanks for proposing an improvement. Please search existing issues first and keep the request aligned with freshdata's focused data-cleaning scope. + + - type: textarea + id: problem + attributes: + label: Problem + description: Describe the problem or limitation this request would address. + placeholder: I want to clean dates in a custom format, but... + validations: + required: true + + - type: textarea + id: proposed-solution + attributes: + label: Proposed solution + description: Describe the behavior you want, including the rules or heuristics for a new cleaning step. + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives considered + description: Describe any alternative solutions or workarounds you considered. + + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Add any other context, examples, or sample data that would help evaluate the request.