Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

write code coverage guide #1744

Merged
merged 17 commits into from
Jun 11, 2019
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ npm start

Visit [http://localhost:2222/](http://localhost:2222/).

**Note:** If you need to debug the documentation build step, run it this way:
**Note:** If you need to debug the documentation build step, run it this way:

```
DEBUG=docs npm run build
Expand All @@ -83,6 +83,14 @@ Add an associated image with the example within the [`source/img/examples`](/sou
{% imgTag /img/examples/name-of-file.jpg "alt text describing img" %}
```

### Using images

If you are starting a new page and want to add images, add a new folder to "themes/cypress/source/img". For example when adding a new "Code Coverage" page to "guides/tooling", I have created new folder "themes/cypress/source/img/guides/code-coverage" and copied an image there called "coverage-object.png". From the page itself, I can include the image using `imgTag`.

```md
{% imgTag /img/guides/code-coverage/coverage-object.png "Code coverage object" %}
```

### Adding Plugins

To add a plugin, submit a [pull request](#Pull-Requests) with the corresponding data added to the [`plugins.yml`](/source/_data/plugins.yml) file. Your plugin should have a name, description, link to the plugin's code, as well as any keywords.
Expand Down
1 change: 1 addition & 0 deletions source/_data/sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ guides:
reporters: reporters.html
typescript-support: typescript-support.html
visual-testing: visual-testing.html
code-coverage: code-coverage.html

references:
assertions: assertions.html
Expand Down
333 changes: 333 additions & 0 deletions source/guides/tooling/code-coverage.md

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions source/ja/_data/sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ guides:
reporters: reporters.html
typescript-support: typescript-support.html
visual-testing: visual-testing.html
code-coverage: code-coverage.html

references:
assertions: assertions.html
Expand Down
1 change: 1 addition & 0 deletions source/zh-cn/_data/sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ guides:
reporters: reporters.html
typescript-support: typescript-support.html
visual-testing: visual-testing.html
code-coverage: code-coverage.html

references:
assertions: assertions.html
Expand Down
1 change: 1 addition & 0 deletions themes/cypress/languages/en.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ sidebar:
module-api: Module API
retry-ability: Retry-ability
visual-testing: Visual Testing
code-coverage: Code Coverage
api:
api: API
table-of-contents: Table of Contents
Expand Down
1 change: 1 addition & 0 deletions themes/cypress/languages/ja.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ sidebar:
module-api: Module API
retry-ability: Retry-ability
visual-testing: Visual Testing
code-coverage: Code Coverage
api:
api: API
table-of-contents: Table of Contents
Expand Down
3 changes: 2 additions & 1 deletion themes/cypress/languages/zh-cn.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,10 @@ sidebar:
plugins-guide: 插件
reporters: Reporters
typescript-support: TypeScript
visual-testing: Visual Testing
module-api: 模块API
retry-ability: 重试机制
visual-testing: Visual Testing
code-coverage: Code Coverage
api:
api: API
table-of-contents: Table of Contents
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.