chore(*): Tweak issue and PR template formatting (#5982)

Opentrons · Jun 23, 2020 · 7651f6c · 7651f6c
1 parent 57cc219
commit 7651f6c
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 54 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,45 +1,39 @@
 ---
 name: Bug report
 about: File a bug
-title: 'bug:'
+title: 'bug: '
 labels: 'bug'
 assignees: ''
 ---
 
 <!--
-  Thanks for taking the time to file an issue! Please make sure you've read the
-  "Opening Issues" section of our Contributing Guide:
+Thanks for taking the time to file an issue! Please make sure you've read the "Opening Issues" section of our Contributing Guide:
 
-  https://github.com/Opentrons/opentrons/blob/edge/CONTRIBUTING.md#opening-issues
+https://github.com/Opentrons/opentrons/blob/edge/CONTRIBUTING.md#opening-issues
 
-  To ensure your issue can be addressed quickly, please fill out the sections
-  below to the best of your ability!
+To ensure your issue can be addressed quickly, please fill out the sections below to the best of your ability!
 -->
 
 # Overview
 
 <!--
-  Use this section to describe your bug at a high level. Please include any
-  issues you can find that may be related.
+Use this section to describe your bug at a high level. Please include any issues you can find that may be related.
 -->
 
-# Current behavior
+# Steps to reproduce
 
 <!--
-  Describe how the software currently behaves and how that differs from how you
-  think the software should behave.
+If this is a bug report and there are specific steps we can take to reproduce the bug, please list them here. This is a good place to put things like software version, hardware version, and operating system.
 -->
 
-# Steps to reproduce
+# Current behavior
 
 <!--
-  If this is a bug report and there are specific steps we can take to reproduce
-  the bug, please list them here. This is a good place to put things like
-  software version, hardware version, and operating system.
+Describe how the software currently behaves and how that differs from how you think the software should behave.
 -->
 
 # Expected behavior
 
 <!--
-  Describe how you think the software should behave.
+Describe how you think the software should behave.
 -->
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -7,35 +7,33 @@ assignees: ''
 ---
 
 <!--
-  Thanks for taking the time to file a feature request! Please make sure you've read the
-  "Opening Issues" section of our Contributing Guide:
+Thanks for taking the time to file a feature request! Please make sure you've read the "Opening Issues" section of our Contributing Guide:
 
-  https://github.com/Opentrons/opentrons/blob/edge/CONTRIBUTING.md#opening-issues
+https://github.com/Opentrons/opentrons/blob/edge/CONTRIBUTING.md#opening-issues
 
-  To ensure your issue can be addressed quickly, please fill out the sections
-  below to the best of your ability!
+To ensure your issue can be addressed quickly, please fill out the sections below to the best of your ability!
 -->
 
 # Overview
 
 <!--
-  Use this section to describe your issue at a high level. Please include some context about why you want this feature. What would this feature allow you to accomplish? Are there any workarounds you use to partially achieve your goal? Are there any issues you could find that may be related?
+Use this section to describe your issue at a high level. Please include some context about why you want this feature. What would this feature allow you to accomplish? Are there any workarounds you use to partially achieve your goal? Are there any issues you could find that may be related?
 -->
 
 # Implementation details
 
 <!--
-  List any implementation steps, specs, or links to docs here.
+List any implementation steps, specs, or links to docs here.
 -->
 
 # Design
 
 <!--
- Attach design images here or link to applicable Zeplin files.
+Attach design images here or link to applicable Zeplin files.
 -->
 
 # Acceptance criteria
 
 <!--
- A checklist of requirements and/or testing steps that must be complete before this feature is considered complete. This can also be used as a testing plan for associated PRs.
+A checklist of requirements and/or testing steps that must be complete before this feature is considered complete. This can also be used as a testing plan for associated PRs.
 -->
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,51 +1,40 @@
 <!--
-  Thanks for taking the time to open a pull request! Please make sure you've
-  read the "Opening Pull Requests" section of our Contributing Guide:
+Thanks for taking the time to open a pull request! Please make sure you've read the "Opening Pull Requests" section of our Contributing Guide:
 
-  https://github.com/Opentrons/opentrons/blob/edge/CONTRIBUTING.md#opening-pull-requests
+https://github.com/Opentrons/opentrons/blob/edge/CONTRIBUTING.md#opening-pull-requests
 
-  To ensure your code is reviewed quickly and thoroughly, please fill out the
-  sections below to the best of your ability!
+To ensure your code is reviewed quickly and thoroughly, please fill out the sections below to the best of your ability!
 -->
 
-## overview
+# Overview
 
 <!--
-  Use this section to describe your pull-request at a high level. If the PR
-  addresses any open issues, please tag the issues here.
+Use this section to describe your pull-request at a high level. If the PR addresses any open issues, please tag the issues here.
 -->
 
-## changelog
+# Changelog
 
 <!--
-  List out the changes to the code in this PR. Please try your best to
-  categorize your changes and describe what has changed and why.
+List out the changes to the code in this PR. Please try your best to categorize your changes and describe what has changed and why.
 
-  Example changelog:
-  - Fixed app crash when trying to calibrate an illegal pipette
-  - Added state to API to track pipette usage
-  - Updated API docs to mention only two pipettes are supported
+Example changelog:
+- Fixed app crash when trying to calibrate an illegal pipette
+- Added state to API to track pipette usage
+- Updated API docs to mention only two pipettes are supported
 
-  IMPORTANT: MAKE SURE ANY BREAKING CHANGES ARE PROPERLY COMMUNICATED
+IMPORTANT: MAKE SURE ANY BREAKING CHANGES ARE PROPERLY COMMUNICATED
 -->
 
-## review requests
+# Review requests
 
 <!--
-  Describe any requests for your reviewers here.
+Describe any requests for your reviewers here.
 -->
 
-## risk assessment
+# Risk assessment
 
 <!--
-  Carefully go over your pull request and look at the other parts of the
-  codebase it may affect. Look for the possibility, even if you think it's
-  small, that your change may affect some other part of the system - for
-  instance, changing return tip behavior in protocol may also change the
-  behavior of labware calibration.
-
-  Identify the other parts of the system your codebase may affect, so that in
-  addition to your own review and testing, other people who may not have
-  the system internalized as much as you can focus their attention and testing
-  there.
+Carefully go over your pull request and look at the other parts of the codebase it may affect. Look for the possibility, even if you think it's small, that your change may affect some other part of the system - for instance, changing return tip behavior in protocol may also change the behavior of labware calibration.
+
+Identify the other parts of the system your codebase may affect, so that in addition to your own review and testing, other people who may not have the system internalized as much as you can focus their attention and testing there.
 -->