JeremyYao commented on code in PR #1401: URL: https://github.com/apache/daffodil-vscode/pull/1401#discussion_r2317248716
########## .github/ISSUE_TEMPLATE/Bug_Report.md: ########## @@ -0,0 +1,25 @@ +## Description + +A clear and concise description of what the bug is. + +## Steps to Reproduce + +1. Go to '...' +2. Click on '...' +3. See error + +## Expected behavior + +What did you expect to happen? + +## Actual behavior + +What actually happened? + +## Screenshots and additional context (optional) Review Comment: Additional context seems slightly specific, would rewording it to `Additional Notes` be broader? ########## .github/ISSUE_TEMPLATE/Bug_Report.md: ########## @@ -0,0 +1,25 @@ +## Description + +A clear and concise description of what the bug is. + +## Steps to Reproduce + Review Comment: Should we include instructions or recommendations of adding screenshots, console outputs, etc as normal text in this section? We may want to omit the `Screenshots and additional context (optional)` section if the user posts screenshots alongside the steps, just so the user doesn't have to go back and forth between two sections. ########## .github/ISSUE_TEMPLATE/Enhancement_Request.md: ########## @@ -0,0 +1,15 @@ +# Enhancement Request: [Concise Title of Enhancement] + +## Summary + +[Provide a brief, high-level overview of the proposed enhancement. What is it, and what problem does it solve?] + +## Proposed Solution / Description + +[Describe the enhancement in detail. How will it work? What are the key features or changes involved? Include any relevant technical details, design considerations, or user flows. You can use bullet points, numbered lists, and code blocks for clarity.] Review Comment: Rephrase `You can use bullet points, numbered lists, and code blocks for clarity.` to `You can use bullet points, numbered lists, code blocks, and diagrams/pictures, for clarity.` ########## .github/ISSUE_TEMPLATE/Bug_Report.md: ########## @@ -0,0 +1,25 @@ +## Description + +A clear and concise description of what the bug is. + +## Steps to Reproduce + +1. Go to '...' +2. Click on '...' +3. See error + +## Expected behavior + +What did you expect to happen? + +## Actual behavior + +What actually happened? + +## Screenshots and additional context (optional) + +## Environment Review Comment: It may be worth considering moving the `Environment` section to above the `Steps to Reproduce Section` as it relates closely to the section. ########## .github/ISSUE_TEMPLATE/Feature_Request,md: ########## Review Comment: The file extension contains a `,` instead of `.`. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
