Skip to content

Commit afeba26

Browse files
Update issue templates / issue template chooser (#8890)
1 parent 19fdf43 commit afeba26

7 files changed

+55
-83
lines changed

.github/ISSUE_TEMPLATE.md

-16
This file was deleted.

.github/ISSUE_TEMPLATE/bug-report.md

+10-11
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,24 @@
11
---
2-
name: "\U0001F41B Bug report"
3-
about: Create a report to help us improve
2+
name: "🐛 Bug report"
3+
about: Report a bug found while using Cypress
44
title: ''
5-
labels: ''
5+
labels: 'type: bug'
66
assignees: ''
7-
87
---
98

10-
<!-- Is this a question? Questions WILL BE CLOSED. Ask in our chat https://on.cypress.io/chat -->
9+
<!-- Use the template below to report a bug. Fill in as much info as possible. As an open source project with a small maintainer team, it may take some time for your issue to be addressed. Please be patient and we will respond as soon as we can. -->
1110

1211
### Current behavior
13-
<!-- A description including screenshots, stack traces, DEBUG logs, etc -->
12+
<!-- A description including screenshots, stack traces, DEBUG logs, etc. See our Troubleshooting Guide: https://on.cypress.io/troubleshooting-->
1413

1514
### Desired behavior
16-
<!-- A clear description of what you want to happen -->
15+
<!-- Remember, we are not familiar with the application you're testing, so please provide a clear description of what should happen. -->
1716

1817
### Test code to reproduce
19-
<!-- If we cannot fully run the tests as provided the issue WILL BE CLOSED -->
20-
<!-- Issues without a reproducible example WILL BE CLOSED -->
18+
<!-- Provide test code that we can copy, paste, and run on our machine to see the issue. -->
2119

22-
<!-- You can fork https://github.com/cypress-io/cypress-test-tiny repo, set up a failing test, then link to your fork -->
20+
<!-- You could also provide a repo that we can clone and run. You can fork https://github.com/cypress-io/cypress-test-tiny repo, set up a failing test, then link to your fork. -->
2321

2422
### Versions
25-
<!-- Cypress, operating system, browser -->
23+
24+
<!-- Cypress version, last known working Cypress version (if applicable), Browser and version, Operating System, CI Provider, etc -->

.github/ISSUE_TEMPLATE/component-testing.md

-31
This file was deleted.

.github/ISSUE_TEMPLATE/config.yml

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
contact_links:
2+
- name: 🤔 Questions and Help
3+
url: https://www.cypress.io/support
4+
about: This issue tracker is not for support questions. Please refer to the Cypress community's support.
5+
- name: 📊 Cypress Dashboard Feature
6+
url: https://portal.productboard.com/cypress-io/1-cypress-dashboard
7+
about: This issue tracker is not for requesting Cypress Dashboard. Please express interest here.
8+
- name: 📃 Documentation Issue
9+
url: https://github.com/cypress-io/cypress-documentation/issues/new
10+
about: This issue tracker is not for documentation issues. Please open documentation issues here.
11+

.github/ISSUE_TEMPLATE/feature.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: "✨ Feature"
3+
about: Suggest a feature or enhancement to improve Cypress
4+
title: ''
5+
labels: 'type: feature'
6+
assignees: ''
7+
---
8+
9+
<!-- Use the template below to request a feature. Please be patient and we will respond as soon as we can. -->
10+
11+
### What would you like?
12+
<!-- A clear description of the feature or enhancement wanted in Cypress -->
13+
14+
### Why is this needed?
15+
<!-- Remember, we are not familiar with the application you are testing, so please provide a clear description of why this would be useful to your project. -->

.github/PULL_REQUEST_TEMPLATE.md

+12-25
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,31 @@
1-
<!--
2-
Thanks for contributing!
3-
Read our contribution guidelines here:
4-
https://github.com/cypress-io/cypress/blob/develop/CONTRIBUTING.md
1+
<!-- Thanks for contributing! PLEASE...
2+
- Read our contributing guidelines: https://github.com/cypress-io/cypress/blob/develop/CONTRIBUTING.md
3+
- Read our Code Review Checklist on coding standards and what needs to be done before a PR can be merged: https://github.com/cypress-io/cypress/blob/develop/CONTRIBUTING.md#Code-Review-Checklist
4+
- Mark this PR as "Draft" if it is not ready for review.
55
-->
66

7-
<!-- Example: "Closes #1234" -->
8-
9-
- Closes <!-- issue number here -->
7+
- Closes <!-- issue number here. e.g. "Closes #1234" -->
108

119
### User facing changelog
12-
13-
<!--
14-
Explain the change(s) for every user to read in our changelog.
15-
-->
10+
<!-- Explain the change(s) for every user to read in our changelog. Examples: https://on.cypress.io/changelog-->
1611

1712
### Additional details
18-
19-
<!--
20-
Examples:
13+
<!-- Examples:
2114
- Why was this change necessary?
2215
- What is affected by this change?
2316
- Any implementation details to explain?
2417
-->
2518

2619
### How has the user experience changed?
27-
28-
<!--
29-
Provide before and after examples of the change.
30-
Screenshots or GIFs are preferred.
31-
-->
20+
<!-- Provide before and after examples of the change.
21+
Screenshots or GIFs are preferred. -->
3222

3323
### PR Tasks
34-
35-
<!--
36-
These tasks must be completed before a PR is merged.
37-
Delete tasks if they are not applicable.
38-
-->
24+
<!-- These tasks must be completed before a PR is merged.
25+
Delete tasks if they are not applicable. -->
3926

4027
- [ ] Have tests been added/updated?
41-
- [ ] Has the original issue been tagged with a release in ZenHub? <!-- (internal team only)-->
28+
- [ ] Has the original issue or this PR been tagged with a release in ZenHub? <!-- (internal team only)-->
4229
- [ ] Has a PR for user-facing changes been opened in [`cypress-documentation`](https://github.com/cypress-io/cypress-documentation)? <!-- Link to PR here -->
4330
- [ ] Have API changes been updated in the [`type definitions`](https://github.com/cypress-io/cypress/blob/develop/cli/types/cypress.d.ts)?
4431
- [ ] Have new configuration options been added to the [`cypress.schema.json`](https://github.com/cypress-io/cypress/blob/develop/cli/schema/cypress.schema.json)?

SECURITY.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Reporting Security Issues
2+
3+
If you believe you've found a potential security issue in Cypress, we want to ensure the correct members of our team are alerted as soon as possible.
4+
5+
Please see our [Security and Compliance](https://cypress.io/security/) for our security disclosure policy and how to report a vulnerability.
6+
7+
https://cypress.io/security/

0 commit comments

Comments
 (0)