Skip to content

Commit c24bc0a

Browse files
author
Ben M
authored
docs: Initial draft of our public triage and process doc. (#23722)
Initial release of the Cypress app triage and prioritization doc
1 parent 4c647f6 commit c24bc0a

File tree

3 files changed

+143
-124
lines changed

3 files changed

+143
-124
lines changed

CONTRIBUTING.md

-124
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ Thanks for taking the time to contribute! :smile:
2020

2121
- [Code of Conduct](#code-of-conduct)
2222
- [Opening Issues](#opening-issues)
23-
- [Triaging Issues](#triaging-issues)
2423
- [Writing Documentation](#writing-documentation)
2524
- [Writing Code](#writing-code)
2625
- [What you need to know before getting started](#what-you-need-to-know-before-getting-started)
@@ -111,129 +110,6 @@ test execution | Running tests inside a single spec | [open](https://github.com/
111110
typescript | Transpiling or bundling TypeScript | [open](https://github.com/cypress-io/cypress/labels/topic%3A%20typescript), [closed](https://github.com/cypress-io/cypress/issues?q=label%3A%22topic%3A+typescript%22+is%3Aclosed)
112111
video | Problems with video recordings | [open](https://github.com/cypress-io/cypress/labels/topic%3A%20video%20%F0%9F%93%B9), [closed](https://github.com/cypress-io/cypress/issues?q=label%3A%22topic%3A+video+%F0%9F%93%B9%22+is%3Aclosed)
113112

114-
## Triaging Issues
115-
116-
When an issue is opened in [cypress](https://github.com/cypress-io/cypress), we need to evaluate the issue to determine what steps should be taken next. So, when approaching new issues, there are some steps that should be taken.
117-
118-
### Is this a question?
119-
120-
Some opened issues are questions, not bug reports or feature requests. Issues are reserved for potential bugs or feature requests *only*. If this is the case, you should:
121-
122-
- Explain that issues in our GitHub repo are reserved for potential bugs or feature requests and that the issue will be closed since it appears to be neither a bug nor a feature request.
123-
- Guide them to existing resources where their questions can be asked like our [Discussions](https://github.com/cypress-io/cypress/discussions), [community chat](https://on.cypress.io/chat), [Discord](https://on.cypress.io/discord), or [Stack Overflow](https://stackoverflow.com/questions/tagged/cypress).
124-
- Cypress offers support via email when signing up for any of our [paid plans](https://www.cypress.io/pricing/), so remind them that this is an option if they already have a paid account.
125-
- Move the issue to [Discussions](https://github.com/cypress-io/cypress/discussions).
126-
127-
### Does this issue belong in this repository?
128-
129-
#### Other open source repos
130-
131-
Issues may be opened about wanting changes to our [documentation](https://github.com/cypress-io/cypress-documentation), our [example-kitchensink app](https://github.com/cypress-io/cypress-example-kitchensink), or [another repository](https://github.com/cypress-io). In this case you should:
132-
133-
- Thank them for their contribution.
134-
- Explain that this repo is only for bugs or feature requests of the Cypress App.
135-
- If you have permission to 'Transfer the issue', do so. If not, explain that they can open an issue in our other repository and link to the repository.
136-
- Close the issue (if not already transferred).
137-
138-
#### Cypress Dashboard
139-
140-
Issues may be opened about wanting features in our Dashboard Service. In this case you should:
141-
142-
- Thank them for opening an issue.
143-
- Add the `external: dashboard` label.
144-
145-
#### Component Testing
146-
147-
Issues may be opened about wanting features in Component Testing. In this case you should:
148-
149-
- Thank them for opening an issue.
150-
- Add the `component testing` label.
151-
152-
### Is this already an open issue?
153-
154-
Search [all issues](https://github.com/cypress-io/cypress/issues) for keywords from the issue to ensure there isn't already an issue open for this. GitHub has some [search tips](https://help.github.com/articles/searching-issues-and-pull-requests/) that may help you better find the relevant issue.
155-
156-
If an issue already exists you should:
157-
158-
- Thank them for their contribution.
159-
- Explain that this issue is a duplicate of another issue, linking to the relevant issue (`#1234`).
160-
- Add the `type: duplicate` label to the issue.
161-
- Close the issue.
162-
163-
### Does the issue provide all the information from our issue template?
164-
165-
When opening an issue, there is a provided issue template based on the type of issue. If the opened issue does not provide enough information asked from the issue template you should:
166-
167-
- Explain that we require new issues follow our provided issue template and that issues that are opened without this information are automatically closed per our [contributing guidelines](#fill-out-our-issue-template).
168-
- Close the issue.
169-
170-
### Are they running the current version of Cypress?
171-
172-
If they listed an older version of Cypress in their issue. We don't want to spend the time to set up a reproducible project (which can be time consuming) only to find that bumping the Cypress version fixes it. You should:
173-
174-
- Ask them to update to the newest version of Cypress and comment about the results.
175-
- Add the `stage: awaiting response` label to the issue.
176-
177-
### Is the fix or feature within our vision for Cypress?
178-
179-
There will inevitably be suggestions that will not fit within the scope of Cypress's vision for our product. If an issue or pull request falls under this category you should:
180-
181-
- Thank them for their contribution.
182-
- Explain why it doesn't fit into the scope at Cypress, and offer clear suggestions for improvement, if you're able. Be kind, but firm.
183-
- Link to relevant documentation, if there is any. If you notice repeated requests for things that are not within scope, add them into the [documentation](https://github.com/cypress-io/cypress-documentation) to avoid repeating yourself.
184-
- Add the `stage: wontfix` label to the issue.
185-
- Close the issue/pull request.
186-
187-
### Is what they're describing actually happening?
188-
189-
The best way to determine the validity of a bug is to recreate it yourself. Follow the directions or information provided to recreate the bug that is described. Did they provide a repository that demonstrates the bug? Great - fork it and run the project and steps required. If they didn't provide a repository, the best way to reproduce the issue is to have a 'sandbox' project up and running locally for Cypress. This is just a simple project with Cypress installed where you can freely edit the application under test and the tests themselves to recreate the problem.
190-
191-
**Attempting to recreate the bug will lead to a few scenarios:**
192-
193-
#### 1. You can't recreate the bug
194-
195-
If you can't recreate the situation happening you should:
196-
197-
- Thank them for their contribution.
198-
- Explain that there isn't enough information to reproduce the bug. Provide information on how you went about recreating the scenario, if you're able. Note your OS, Browser, Cypress version and any other information.
199-
- Note that if no reproducible example is provided, we will unfortunately have to close the issue.
200-
- Add the `stage: needs information` label to the issue.
201-
202-
#### 2. You can recreate the bug
203-
204-
If you can recreate the bug you should:
205-
206-
- Thank them for their contribution.
207-
- Explain that you're able to recreate the bug. Provide the exact test code ran and the versions of Cypress, OS, and browser you used to recreate it.
208-
- If you know where the code is that could possibly fix this issue - link to the file or line of code from the [cypress](https://github.com/cypress-io/cypress) repo and remind the user that we are open source and that we gladly accept PRs, even if they are a work in progress.
209-
- Add the `stage: ready for work` label to the issue.
210-
211-
#### 3. You can tell the problem is a user error
212-
213-
In recreating the issue, you may realize that they had a typo or used the Cypress API incorrectly, etc. In this case you should:
214-
215-
- Leave a comment informing the user of their error.
216-
- Link to relevant documentation, if there is any. If you notice repeated user errors for the same situation, add them into the [documentation](https://github.com/cypress-io/cypress-documentation) to avoid repeating yourself.
217-
- Close the issue.
218-
219-
### Has the issue gone stale?
220-
221-
Some issues are opened and sadly forgotten about by the person originally opening the issue.
222-
223-
#### Not enough information ever provided
224-
225-
Sometimes we request more information to be provided (label `stage: needs information`) for an open issue, but no one is able to provide a reproducible example or they simply never respond. **This does not mean that we don't believe that there is a bug!** We just, unfortunately, don't have a path forward to fix it without this information. In this case you should:
226-
227-
- Add a comment reminding them or our request for more information and that the issue will be closed if it is not provided. Sometimes issues get forgotten about, and all the person needs is a gentle reminder.
228-
- If there is still no response after a weeks time, explain that you are closing the issue due to not enough information or inactivity and that they can comment in the issue with a reproducible example and we will reopen the issue.
229-
- Close the issue.
230-
231-
#### They already solved their issue
232-
233-
Some issues are resolved by the community, by giving some guidance or a workaround, but the original opener of the issue forgets to close the issue. In this case you should:
234-
235-
- Explain that you are closing the issue as resolved and that they can comment if they are still having the issue and we will consider reopening it.
236-
- Close the issue.
237113

238114
## Writing Documentation
239115

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,10 @@ yarn add cypress --dev
6767

6868
Please see our [Contributing Guideline](./CONTRIBUTING.md) which explains repo organization, linting, testing, and other steps.
6969

70+
## How we work
71+
72+
At Cypress we value our community and strive to be as open and transparent with them as possible. Check out [our guide](./cypress-prioritization-and-triage.md) on how we prioritize community issues.
73+
7074
## License
7175

7276
[![license](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/cypress-io/cypress/blob/develop/LICENSE)

0 commit comments

Comments
 (0)