graal icon indicating copy to clipboard operation
graal copied to clipboard

[GR-45874] Update GitHub Issue Template for Improved User Issue Reporting

Open fernando-valdez opened this issue 1 year ago • 4 comments

Summary

This PR updates the GitHub issue template to help users file new issues more effectively. The changes aim to streamline the issue reporting process, ensuring that users provide all necessary information for quicker and more accurate troubleshooting.

Changes

  • Added new sections for environment details, steps to reproduce, and expected behavior.
  • Included guidelines for providing clear and concise issue titles.
  • Added placeholders for logs and screenshots to better illustrate issues.
  • Updated formatting for improved readability and user guidance.

Benefits

  • Encourages users to provide comprehensive details, reducing back-and-forth communication.
  • Helps maintainers and contributors understand and reproduce issues faster.
  • Improves the overall efficiency of issue triage and resolution.

Checklist

  • [x] Reviewed the new template for completeness and clarity.
  • [x] Tested the template with sample issues to ensure usability.

fernando-valdez avatar Jul 31 '24 03:07 fernando-valdez

Please rebase it to master so there are no merge commits.

vjovanov avatar Aug 01 '24 12:08 vjovanov

If the crash report can not be fused with build-time error, I think we are good for now. We will see how the fields work in practice and adjust.

vjovanov avatar Aug 01 '24 12:08 vjovanov

Please squash all commits and rebase to master. There should be no merge commits.

vjovanov avatar Aug 08 '24 05:08 vjovanov

There needs to be a single commit that is merged. Please assure that we don't merge 36 commits.

vjovanov avatar Aug 09 '24 15:08 vjovanov