Browse Source

chore: clean up issue templates (#17085)

* chore: clean up issue templates

* address feedback from review

* cleanup
Shelley Vohr 6 years ago
parent
commit
be8f9bd597

+ 7 - 7
.github/ISSUE_TEMPLATE/Bug_report.md

@@ -4,17 +4,17 @@ about: Create a report to help us improve Electron
 
 ---
 
-* **Electron Version** (output of `node_modules/.bin/electron --version`):
-  * <!-- e.g. 4.0.3 -->
-* **Operating System** (Platform and Version):
-  * <!-- e.g. macOS 10.13.6 / Windows 10 (1803) / Ubuntu 18.04 x64 -->
-* **Last known working Electron version** (if applicable):
-  * <!-- e.g. 3.1.0 -->
+* **Electron Version:**
+  * <!-- (output of `node_modules/.bin/electron --version`) e.g. 4.0.3 -->
+* **Operating System:**
+  * <!-- (Platform and Version) e.g. macOS 10.13.6 / Windows 10 (1803) / Ubuntu 18.04 x64 -->
+* **Last Known Working Electron version:**:
+  * <!-- (if applicable) e.g. 3.1.0 -->
 
 ### Expected Behavior
 <!-- A clear and concise description of what you expected to happen. -->
 
-### Actual behavior
+### Actual Behavior
 <!-- A clear and concise description of what actually happened. -->
 
 ### To Reproduce

+ 8 - 8
.github/ISSUE_TEMPLATE/Feature_request.md

@@ -4,14 +4,14 @@ about: Suggest an idea for Electron
 
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is.
+### Problem Description
+<!-- Is your feature request related to a problem? PLease add a clear and concise description of what the problem is. -->
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+### Proposed Solution
+<!-- Describe the solution you'd like in a a clear and concise manner -->
 
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+### Alternatives Considered
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
 
-**Additional context**
-Add any other context or screenshots about the feature request here.
+### Additional Information
+<!-- Add any other context about the problem here. -->

+ 0 - 13
.github/ISSUE_TEMPLATE/mac-app-store-private-api-rejection.md

@@ -1,13 +0,0 @@
----
-name: Mac App Store Private API Rejection
-about: Your app was rejected from the Mac App Store for using private API's
-
----
-
-* Electron Version: 
-
-**Rejection Email**
-Paste the contents of your rejection email here, censoring any private information such as app names.
-
-**Additional Information**
-Add any other context about the problem here.

+ 14 - 0
.github/ISSUE_TEMPLATE/mac_app_store_private_api_rejection.md

@@ -0,0 +1,14 @@
+---
+name: Mac App Store Private API Rejection
+about: Your app was rejected from the Mac App Store for using private API's
+
+---
+
+* **Electron Version:** 
+  * <!-- (output of `node_modules/.bin/electron --version`) e.g. 4.0.3 -->
+
+### Rejection Email
+<!-- Paste the contents of your rejection email here, censoring any private information such as app names.-->
+
+### Additional Information
+<!-- Add any other context about the problem here. -->

+ 3 - 2
.github/ISSUE_TEMPLATE/security-report.md → .github/ISSUE_TEMPLATE/security_report.md

@@ -4,6 +4,7 @@ about: Do not create an issue for security reports, send an email to security@el
 
 ---
 
-Do not create an issue for security reports, send an email to:
+### Notice 
 
[email protected]
+**DO NOT** create an issue for security reports.
+Send an email to: **[email protected]**.

+ 0 - 1
.github/PULL_REQUEST_TEMPLATE.md

@@ -16,7 +16,6 @@ Contributors guide: https://github.com/electron/electron/blob/master/CONTRIBUTIN
 - [ ] PR title follows semantic [commit guidelines](https://github.com/electron/electron/blob/master/docs/development/pull-requests.md#commit-message-guidelines)
 - [ ] [PR release notes](https://github.com/electron/clerk/blob/master/README.md) describe the change in a way relevant to app developers, and are [capitalized, punctuated, and past tense](https://github.com/electron/clerk/blob/master/README.md#examples).
 
-
 #### Release Notes
 
 Notes: <!-- Please add a one-line description for app developers to read in the release notes, or `no-notes` if no notes relevant to app developers. Examples and help on special cases: https://github.com/electron/clerk/blob/master/README.md#examples -->