[GH-2415] Modernize issue template workflow - #3221
Conversation
jiayuasu
left a comment
There was a problem hiding this comment.
With only this template, the new-issue chooser will offer "Bug report" plus a blank issue (blank issues stay enabled by default), so feature requests and questions will land as unstructured blank issues. Consider adding .github/ISSUE_TEMPLATE/config.yml with contact links pointing questions to GitHub Discussions and the dev@sedona.apache.org mailing list. A feature request template would complete the set; that can also be a follow-up PR.
| - Scala | ||
| - Java | ||
| - Python | ||
| - Other |
There was a problem hiding this comment.
Sedona also ships an R package, and many users work through Spark SQL only. Adding these avoids routing them to "Other":
| - Scala | |
| - Java | |
| - Python | |
| - Other | |
| - Scala | |
| - Java | |
| - Python | |
| - SQL | |
| - R | |
| - Other |
There was a problem hiding this comment.
Addressed in 686f0ea. The API dropdown now offers Scala, Java, Python, SQL, R, and Other.
| id: reproduction-steps | ||
| attributes: | ||
| label: Steps to reproduce | ||
| description: Provide a minimal example or the exact steps that reproduce the problem. |
There was a problem hiding this comment.
Pasted code and stack traces in this field often lose formatting. Either add render: shell to this textarea (renders the entire field as a code block) or extend the description to ask for code fences. A separate checkboxes field asking the reporter to confirm they searched existing issues would also help cut duplicates.
There was a problem hiding this comment.
Addressed in 686f0ea. The reproduction field now uses shell rendering, and the form includes a required confirmation that the reporter searched existing issues.
|
Addressed the issue-chooser feedback in 686f0ea by adding config.yml, disabling blank issues, and linking GitHub Discussions plus the Sedona developer mailing list. I left a feature-request form for a follow-up, as suggested. |
Did you read the Contributor Guide?
Is this PR related to a ticket?
What changes were proposed in this PR?
Replace the legacy repository-wide Markdown issue template with a GitHub issue form under
.github/ISSUE_TEMPLATE. The form preserves the existing expected behavior, actual behavior, reproduction, version, API, and environment prompts while using GitHub’s current issue-template workflow.The updated form also:
How was this patch tested?
pre-commit run --files .github/ISSUE_TEMPLATE/bug_report.yml .github/ISSUE_TEMPLATE/config.ymlgit diff --checkDid this PR include necessary documentation updates?