diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index ec046f9f60b..02c5f8199a4 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,6 +1,6 @@ --- name: Bug report -about: Create a report to help us improve +about: Create a report to help us improve. title: '' labels: bug assignees: '' @@ -14,13 +14,14 @@ A clear and concise description of what the bug or issue is. - [ ] I've verified the issue is reproducible against the latest version of the project. - [ ] I've checked the existing issues to verify this issue is not already known. -**Minimum Reproducible Example** +**Minimal Reproducible Example** A clear and concise description of what happened. +Please include steps on how to reproduce the issue.
Logs - + ```shell your logs here ``` @@ -30,13 +31,13 @@ A clear and concise description of what happened. A clear and concise description of what you expected to happen. -**Setup (please complete the following information):** +**Details setup (please complete the following information):** - - Operating System (e.g. MacOS Monterey) - - Java Version (i.e. `java --version`, e.g. `17`) - - Error Prone Version [e.g. `2.15`] - - Error Prone Support Version [e.g. `0.2.0`] + - Operating system (e.g. MacOS Monterey) + - Java version (i.e. `java --version`, e.g. `17.0.3`) + - Error Prone version [e.g. `2.15.0`] + - Error Prone Support version [e.g. `0.2.0`] **Additional context** -Add any other context about the problem here. +Provide any other context about the problem here.