Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce more efficient Form-Based GitHub Issue Templates #4042

Merged
merged 2 commits into from
Jul 15, 2023

Conversation

JooHyukKim
Copy link
Member

Motivation

There have been many issues where repeatedly advising to..

  • Write reproducible samples
  • redirect to kotlin
  • convert to Java, minimize
  • remove framework (Spring or lombok)

The aim of this PR is to update the issue templates to utilize GitHub's new form-based templates. This PR will try to maintain original content as much as possible. Will save enhancements for later.

Benefits

This change has been driven by the following benefits:

  • Improved User Experience: These new templates are interactive, making it easier and more intuitive for users to submit issues.
  • Structured Responses: Enforcing the necessary structure helps us to capture comprehensive details about the issue from the users.
  • Efficient Triage: With the required information being captured upfront in a consistent manner, issue triaging becomes more efficient.

Sample (Live demo)

For a live demonstration of these templates, you can refer to: https://github.com/JooHyukKim/test-github-templ/issues/new/choose

About Further Work

If this PR is accepted, then we can discuss adding checklists for bug reports such as...

  • Minimal reproduction
  • Reproduction is in Java with only Jackson involved
  • No other libraries or frameworks in Java (if kotlin, link-to-kotlin)?
  • Is it reproducible?
  • Is used Mapper configuration provided?

Note

Feedbacks are super welcome!

@cowtowncoder
Copy link
Member

Sounds good to me. WDYT @pjfanning ?

@pjfanning
Copy link
Member

seems like a good idea - I haven't watched the demo though

@cowtowncoder
Copy link
Member

Ok, demo looks good -- I think I might as well merge it and can tweak later on as necessary. And also roll out to other repos based on experiences, feedback.

Thank you @JooHyukKim !

@cowtowncoder cowtowncoder merged commit dc19ee8 into FasterXML:2.15 Jul 15, 2023
4 checks passed
@JooHyukKim JooHyukKim deleted the Improve-issue-templates branch July 16, 2023 04:54
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.

3 participants