Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 0 additions & 33 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

82 changes: 82 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -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
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/documentation.md

This file was deleted.

33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -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.
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -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.
Loading