dev: add GitHub detailed issue templates (#1591)
* dev: add GitHub detailed issue templates * dev: update PR template contributing guidelines link is already in PR UI changelog message is no longer needed -- it is generated from commit messages * dev: use bug report template on CMS crash * Update bug_report.md
This commit is contained in:
parent
0cd82f11cc
commit
05622b8eee
44
.github/ISSUE_TEMPLATE.md
vendored
44
.github/ISSUE_TEMPLATE.md
vendored
@ -1,44 +0,0 @@
|
|||||||
<!--
|
|
||||||
If you are reporting a new issue, make sure that we do not have any duplicates
|
|
||||||
already open. You can ensure this by searching the issue list for this
|
|
||||||
repository. If there is a duplicate, please close your issue and add a comment
|
|
||||||
to the existing issue instead.
|
|
||||||
|
|
||||||
If you suspect your issue is a bug, please edit your issue description to
|
|
||||||
include the BUG REPORT INFORMATION shown below. If you fail to provide this
|
|
||||||
information within 7 days, we cannot debug your issue and will close it. We
|
|
||||||
will, however, reopen it if you later provide the information.
|
|
||||||
|
|
||||||
If you have an issue that can be shown visually, please provide a screenshot or
|
|
||||||
gif of the problem as well.
|
|
||||||
|
|
||||||
---------------------------------------------------
|
|
||||||
BUG REPORT INFORMATION
|
|
||||||
---------------------------------------------------
|
|
||||||
Use the commands below to provide key information from your environment:
|
|
||||||
You do NOT have to include this information if this is a FEATURE REQUEST
|
|
||||||
-->
|
|
||||||
|
|
||||||
**- Do you want to request a *feature* or report a *bug*?**
|
|
||||||
|
|
||||||
**- What is the current behavior?**
|
|
||||||
|
|
||||||
**- If the current behavior is a bug, please provide the steps to reproduce.**
|
|
||||||
|
|
||||||
**- What is the expected behavior?**
|
|
||||||
|
|
||||||
<!--
|
|
||||||
The following information is not required, but please provide as much as
|
|
||||||
possible to help us resolve your issue.
|
|
||||||
-->
|
|
||||||
|
|
||||||
**- Please mention your versions where applicable.**
|
|
||||||
<!-- You can find the CMS version by checking your web browser's developer tools console while in the CMS. -->
|
|
||||||
Netlify CMS version:
|
|
||||||
Browser version:
|
|
||||||
<!-- If using NPM: -->
|
|
||||||
Node.JS version:
|
|
||||||
Operating System:
|
|
||||||
|
|
||||||
|
|
||||||
**- Please link or paste your `config.yml` below if applicable.**
|
|
45
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
45
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@ -0,0 +1,45 @@
|
|||||||
|
---
|
||||||
|
name: Bug report
|
||||||
|
about: Report a problem you are experiencing
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
<!--
|
||||||
|
If you are reporting a new issue, make sure that we do not have any duplicates already open. You can ensure this by searching the issue list for this repository. If there is a duplicate, please add a comment to the existing issue instead.
|
||||||
|
|
||||||
|
Please include as much of the information requested below as possible. If you fail to provide the requested information within 7 days, we cannot debug your issue and will close it. We will, however, reopen it if you later provide the information.
|
||||||
|
|
||||||
|
If you have an issue that can be shown visually, please provide a screenshot or GIF of the problem as well.
|
||||||
|
-->
|
||||||
|
|
||||||
|
**Describe the bug**
|
||||||
|
A clear and concise description of what the bug is.
|
||||||
|
|
||||||
|
**To Reproduce**
|
||||||
|
Steps to reproduce the behavior:
|
||||||
|
1. Go to '...'
|
||||||
|
2. Click on '....'
|
||||||
|
3. Scroll down to '....'
|
||||||
|
4. See error
|
||||||
|
|
||||||
|
**Expected behavior**
|
||||||
|
A clear and concise description of what you expected to happen.
|
||||||
|
|
||||||
|
**Screenshots**
|
||||||
|
If applicable, add screenshots to help explain your problem.
|
||||||
|
|
||||||
|
**Applicable Versions:**
|
||||||
|
<!-- You can find the CMS version by checking your web browser's developer tools console while in the CMS. -->
|
||||||
|
- Netlify CMS version: [e.g. 2.0.4]
|
||||||
|
- Git provider: [e.g. GitHub, BitBucket]
|
||||||
|
- OS: [e.g. Windows 7]
|
||||||
|
- Browser version [e.g. chrome 22, safari 11]
|
||||||
|
<!-- If using NPM: -->
|
||||||
|
- Node.JS version:
|
||||||
|
|
||||||
|
**CMS configuration**
|
||||||
|
Please link or paste your CMS `config.yml` here.
|
||||||
|
|
||||||
|
|
||||||
|
**Additional context**
|
||||||
|
Add any other context about the problem here.
|
21
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
21
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
---
|
||||||
|
name: Feature request
|
||||||
|
about: Suggest an idea for this project
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Please make sure that we do not have any requests for this feature already open. You can ensure this by searching the issue list for this repository. If there is a duplicate, please add a comment to the existing issue instead.
|
||||||
|
-->
|
||||||
|
|
||||||
|
**Is your feature request related to a problem? Please describe.**
|
||||||
|
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||||
|
|
||||||
|
**Describe the solution you'd like**
|
||||||
|
A clear and concise description of what you want to happen.
|
||||||
|
|
||||||
|
**Describe alternatives you've 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.
|
18
.github/PULL_REQUEST_TEMPLATE.md
vendored
18
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -1,35 +1,27 @@
|
|||||||
<!--
|
<!--
|
||||||
Thanks for submitting a pull request!
|
Thanks for submitting a pull request!
|
||||||
|
|
||||||
Please make sure you've read and understood our contributing guidelines;
|
Please make sure you've read and understood our contributing guidelines.
|
||||||
https://github.com/netlify/netlify-cms/blob/master/CONTRIBUTING.md
|
|
||||||
|
|
||||||
If this is a bug fix, make sure your description includes "fixes #xxxx", or
|
If this is a bug fix, make sure your description includes "fixes #xxxx", or
|
||||||
"closes #xxxx", where #xxxx is the issue number.
|
"closes #xxxx", where #xxxx is the issue number.
|
||||||
|
|
||||||
Please provide enough information so that others can review your pull request.
|
Please provide enough information so that others can review your pull request.
|
||||||
The first three fields are mandatory:
|
The first two fields are mandatory:
|
||||||
-->
|
-->
|
||||||
|
|
||||||
**- Summary**
|
**Summary**
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
Explain the **motivation** for making this change.
|
Explain the **motivation** for making this change.
|
||||||
What existing problem does the pull request solve?
|
What existing problem does the pull request solve?
|
||||||
-->
|
-->
|
||||||
|
|
||||||
**- Test plan**
|
**Test plan**
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
Demonstrate the code is solid.
|
Demonstrate the code is solid.
|
||||||
Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI.
|
Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
**- Description for the changelog**
|
**A picture of a cute animal (not mandatory but encouraged)**
|
||||||
|
|
||||||
<!--
|
|
||||||
Write a short (one line) summary that describes the changes in this
|
|
||||||
pull request for inclusion in the changelog:
|
|
||||||
-->
|
|
||||||
|
|
||||||
**- A picture of a cute animal (not mandatory but encouraged)**
|
|
||||||
|
@ -2,7 +2,7 @@ import React from 'react';
|
|||||||
import { css } from 'react-emotion';
|
import { css } from 'react-emotion';
|
||||||
import { colors } from 'netlify-cms-ui-default';
|
import { colors } from 'netlify-cms-ui-default';
|
||||||
|
|
||||||
const ISSUE_URL = 'https://github.com/netlify/netlify-cms/issues/new';
|
const ISSUE_URL = 'https://github.com/netlify/netlify-cms/issues/new?template=bug_report.md';
|
||||||
|
|
||||||
const styles = {
|
const styles = {
|
||||||
errorBoundary: css`
|
errorBoundary: css`
|
||||||
|
Loading…
x
Reference in New Issue
Block a user