Files
cypress/README.md
Ben M c24bc0aad6 docs: Initial draft of our public triage and process doc. (#23722)
Initial release of the Cypress app triage and prioritization doc
2022-09-22 09:32:30 -04:00

89 lines
2.9 KiB
Markdown

<p align="center">
<a href="https://www.cypress.io">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="./assets/cypress-logo-dark.png">
<source media="(prefers-color-scheme: light)" srcset="./assets/cypress-logo-light.png">
<img alt="Cypress Logo" src="./assets/cypress-logo-light.png">
</picture>
</a>
</p>
<p align="center">
<a href="https://on.cypress.io">Documentation</a> |
<a href="https://on.cypress.io/changelog">Changelog</a> |
<a href="https://on.cypress.io/roadmap">Roadmap</a>
</p>
<h3 align="center">
The web has evolved. Finally, testing has too.
</h3>
<p align="center">
Fast, easy and reliable testing for anything that runs in a browser.
</p>
<p align="center">
Join us, we're <a href="https://cypress.io/jobs">hiring</a>.
</p>
<p align="center">
<a href="https://www.npmjs.com/package/cypress">
<img src="https://img.shields.io/npm/dm/cypress.svg" alt="npm"/>
</a>
<a href="https://gitter.im/cypress-io/cypress">
<img src="https://img.shields.io/gitter/room/cypress-io/cypress.svg" alt="Gitter chat"/>
</a>
<a href="https://stackshare.io/cypress">
<img src="https://img.stackshare.io/misc/follow-on-stackshare-badge.svg" alt="StackShare"/>
</a><br />
</p>
## What is Cypress?
<p align="center">
<a href="https://player.vimeo.com/video/237527670">
<img alt="Why Cypress Video" src="https://user-images.githubusercontent.com/1271364/31739717-dbdff0ee-b41c-11e7-9b16-bfa1b6ac1814.png" width="75%" height="75%" />
</a>
</p>
## Installing
[![npm version](https://badge.fury.io/js/cypress.svg)](https://badge.fury.io/js/cypress)
Install Cypress for Mac, Linux, or Windows, then [get started](https://on.cypress.io/install).
```bash
npm install cypress --save-dev
```
or
```bash
yarn add cypress --dev
```
![installing-cli e1693232](https://user-images.githubusercontent.com/1271364/31740846-7bf607f0-b420-11e7-855f-41c996040d31.gif)
## Contributing
- [![CircleCI](https://circleci.com/gh/cypress-io/cypress/tree/develop.svg?style=svg)](https://circleci.com/gh/cypress-io/cypress/tree/develop) - `develop` branch
Please see our [Contributing Guideline](./CONTRIBUTING.md) which explains repo organization, linting, testing, and other steps.
## How we work
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.
## License
[![license](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/cypress-io/cypress/blob/develop/LICENSE)
This project is licensed under the terms of the [MIT license](/LICENSE).
## Badges
Let the world know your project is using Cypress.io to test with this cool badge
[![Cypress.io](https://img.shields.io/badge/tested%20with-Cypress-04C38E.svg)](https://www.cypress.io/)
```
[![Cypress.io](https://img.shields.io/badge/tested%20with-Cypress-04C38E.svg)](https://www.cypress.io/)
```