Skip to content

[GH-2415] Modernize issue template workflow - #3221

Merged
jiayuasu merged 2 commits into
apache:masterfrom
lntutor:docs/gh-2415-issue-template-workflow
Jul 31, 2026
Merged

[GH-2415] Modernize issue template workflow#3221
jiayuasu merged 2 commits into
apache:masterfrom
lntutor:docs/gh-2415-issue-template-workflow

Conversation

@lntutor

@lntutor lntutor commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Did you read the Contributor Guide?

  • Yes, I have read the Contributor Rules and Contributor Development 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:

  • preserves pasted reproduction commands and stack traces with shell rendering;
  • offers Scala, Java, Python, SQL, R, and Other API choices;
  • requires reporters to confirm that they searched for duplicates; and
  • routes questions to GitHub Discussions or the developer mailing list instead of unstructured blank issues.

How was this patch tested?

  • pre-commit run --files .github/ISSUE_TEMPLATE/bug_report.yml .github/ISSUE_TEMPLATE/config.yml
  • git diff --check

Did this PR include necessary documentation updates?

  • No, this PR does not affect any public API so no need to change the documentation.

@lntutor
lntutor requested a review from jiayuasu as a code owner July 31, 2026 14:06

@jiayuasu jiayuasu left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment on lines +68 to +71
- Scala
- Java
- Python
- Other

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sedona also ships an R package, and many users work through Spark SQL only. Adding these avoids routing them to "Other":

Suggested change
- Scala
- Java
- Python
- Other
- Scala
- Java
- Python
- SQL
- R
- Other

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed in 686f0ea. The reproduction field now uses shell rendering, and the form includes a required confirmation that the reporter searched existing issues.

@lntutor

lntutor commented Jul 31, 2026

Copy link
Copy Markdown
Contributor Author

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.

@jiayuasu jiayuasu left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@jiayuasu
jiayuasu merged commit 19a92c7 into apache:master Jul 31, 2026
12 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.

Warning You are using an old version of issue templates. Please update to the new issue template workflow.

2 participants