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

Conversation

2 participants
@bahmutov
Copy link
Collaborator

commented Jun 4, 2019

@bahmutov bahmutov changed the title WIP: start code coverage guide write code coverage guide Jun 5, 2019

@bahmutov bahmutov requested a review from jennifer-shehane Jun 5, 2019

@jennifer-shehane

This comment has been minimized.

Copy link
Member

commented Jun 6, 2019

I will give this a look tomorrow. Got caught up in some performance testing today.

@jennifer-shehane
Copy link
Member

left a comment

I don't think that this quite meets the same standard as our other guides - of introducing the concept to programmers new to code coverage.

I don't think that explaining every code coverage concept is necessarily something we should be responsible for, just having a link in a note towards the beginning like, "New to code coverage? Read this outline first" may do. Do you have a good resource to refer people to?

Mostly, as a novice to code coverage myself, I felt that I was walking into terminology and tooling that I should've had some previous knowledge of before reading this doc. Particularly where you jump into 'instrumenting your code' - as if I should know this term 'instrument' and understand how Istanbul already works.

This is fine! I would just like it noted like - "You should read up on Istanbul first before jumping into this section" if so.

I added a bit of a softer intro, but maybe you can soften up some of the other sections for other noobs like me. 😄

@bahmutov

This comment has been minimized.

Copy link
Collaborator Author

commented Jun 7, 2019

bahmutov added some commits Jun 10, 2019

@bahmutov

This comment has been minimized.

Copy link
Collaborator Author

commented Jun 10, 2019

@jennifer-shehane appreciate your feedback and understand what you mean, I will add an introduction to make it super clear why we are jumping into Istanbul and instrumentation

@bahmutov bahmutov requested a review from jennifer-shehane Jun 10, 2019

@bahmutov

This comment has been minimized.

Copy link
Collaborator Author

commented Jun 10, 2019

wrote introduction section that should gently explain code coverage, also added links to a blog post that is pretty good explaining the same thing in detail

bahmutov and others added some commits Jun 10, 2019

@jennifer-shehane

This comment has been minimized.

Copy link
Member

commented Jun 11, 2019

oh, I just realized I forgot to push my previous changes. Will be merging this in. sorry.

@jennifer-shehane
Copy link
Member

left a comment

The part about it adding counters is still a little bit like, 'wat?'. Mostly because I'm thinking to myself - where is it doing this? Is it editing my code and adding this in? Is it creating a new file with this info? Where is this new file?

But, overall I think a good start to go ahead and merge in.

@bahmutov bahmutov merged commit 1543ac0 into develop Jun 11, 2019

3 checks passed

ci/circleci: build Your tests passed on CircleCI!
Details
ci/circleci: docs-tests Your tests passed on CircleCI!
Details
license/cla Contributor License Agreement is signed.
Details

jennifer-shehane added a commit that referenced this pull request Jun 21, 2019

Moved Custom Reporters section to bottom the page (#1742)
* Moved Custom Reporters section to bottom the page

To improve usability.

* Added link to Section 9 (reporters) of workshop

* fix link to demo-docker-cypress-included repo, close #1743

* add Aurelia CLI to framework tooling plugins

* add code-coverage plugin

* chore(deps): update dependency husky to version 2.4.0 🌟 (#1748)



Co-authored-by: Renovate Bot <bot@renovateapp.com>

* chore(deps): update dependency lint-staged to version 8.2.0 🌟 (#1749)



Co-authored-by: Renovate Bot <bot@renovateapp.com>

* Maintenance of docs content (#1751)

* update existing history tables to link to changelog + remove leading |

* add missing iscy.md to japanese files

* Add history tables to more pages

* Add text lint rules for URL and HTML to always be allcaps

* wip converting markdown image tags to imgTag + replacing outside hosted images with own hosted images

* Fix more imgTags and headers in en/ja files

* Added more names/brands to testlint + fixes

* Fix misuse of compliment when meaning complement

* Replace ableist terms, recommend better terms in linting

* convert more image tags / headers

* Add textlint rules for CORS, cross-origin, and Develop Tools (use generic instead of Chrome brandname)

* Fix broken links due to lint conversions

* Fix more imgTags + headers

* Updating more imgTag + headers

* Set textlint rules + fixes for XHR, localStorage, sessionStorage and iframe

* finish replacing all imgTags and headers

* remove unused sidebar links/translations + add japanese title to all ja docs

* Fix words missing first char in chagelogs

- Add more history tables
- Add some missing documentation after reading changelogs

* remove moment from textlint, fix incorrect uses of moment.

- Add WebSocket/WebSockets, iframes, HTTP / HTTPS, SSO to textlint
- Remove use of word 'simply' and add to textlint

* Fix Cypress' pluralization

* Plugins - Add cypress-unfetch (#1750)

* cypress-unfetch

* cypress-unfetch plugin for en, ja and zh-cn

* emphasize copying English is ok for PR template

* fix(deps): Update dependency hexo-algoliasearch to version 0.3.2 🌟 (#1755)



Co-authored-by: Renovate Bot <bot@renovateapp.com>

* chore(deps): update dependency to version 🌟 (#1756)



Co-authored-by: Renovate Bot <bot@renovateapp.com>

* update area of screenshots and videos to link to visual testing guide (#1757)

* update area of screenshots and videos to link to visual testing guide

- Also mention that video capturing is only supported in electron.

* Add visual testing guide to other sections of docs

* Change: 'spy' -> 'stub' for 'window' recipe (#1759)

* typo "can not" -> "cannot"

* typo "can not" -> "cannot"

* typo "can not" -> "cannot"

* typo "can not" -> "cannot"

* typo "can not" -> "cannot"

* typo "can not" -> "cannot"

* add ["can[- ]not", "cannot$1"]

add ["can[- ]not", "cannot$1"] to change "can not" to "cannot"

* its -> it is

* its -> it's

* its -> it is

* Update url_generator.js

* Fix typo reenable > reenabled

* Fix typo reenable > reenabled

* Change: 'spy' -> 'stub' for 'window' recipe

* Change: 'spy' -> 'stub' for 'window' recipe

* Change: 'spy' -> 'stub' for 'window' recipe

* write code coverage guide (#1744)

* start code coverage guide

* write section about instrumenting code

* add code coverage to Ja sidebar

* more content for code coverage document

* finish section on unit testing

* Add Istanbul to textlintrc

* Editing / add intro paragraph

* package-lock

* woops, fixed some of the code formatters

* fix DevTools term

* write introduction section

* add blank line to pass linter

* Add code coverage docs to ja/cn

* fix missing image in launching browsers guide

* add logging in using JWT recipe link (#1762)

* chore(deps): Update dependency husky to version 2.4.1 🌟 (#1764)



Co-authored-by: Renovate Bot <bot@renovateapp.com>

* chore(deps): Update dependency gulp-rev-all to version 2.0.2 🌟 (#1760)



Co-authored-by: Renovate Bot <bot@renovateapp.com>

* add code coverage webpack-dev-server example link

* chore(deps): update dependency lint-staged to version 8.2.1 🌟 (#1770)



Co-authored-by: Renovate Bot <bot@renovateapp.com>

* chore(deps): update dependency @types/jest to version 24.0.14 🌟 (#1767)



Co-authored-by: Renovate Bot <bot@renovateapp.com>

* Add Cypress courses page (#1766)

* start courses page

* add spanish language course

* add pluralsight

* add second udemy course

* Remove courses template - move into media template

- Try to fix up layout of courses to look nicer

* Fix up courses placement + layout, add intro paragraph

* Add new podcast

* Add specific messages for when tests failing that loop through languages fail - print lang it failed on.

* Copy courses content over to translated docs


Co-authored-by: Jennifer Shehane <jennifer@cypress.io>

* add section to debugging on how to change test runner code (#1769)

* add section to debugging on how to change test runner code

* Edit debug instructions

- call it 'installed Cypress code'
- Link to cache path command
- Do not include 'code' command - this will confuse users if it doesn't work copy/paste, just tell them to open it in their code editor

* copy new debug content to translated docs


Co-authored-by: Jennifer Shehane <jennifer@cypress.io>

* add screenshot how to change browser (#1768)

* add screenshot how to change browser

* copy to ja and cn

* minor editing


Co-authored-by: Jennifer Shehane <jennifer@cypress.io>

* add xebia training course (#1773)

* chore(deps): Update dependency snap-shot-it to version 7.7.0 🌟 (#1775)



Co-authored-by: Renovate Bot <bot@renovateapp.com>

* chore(deps): update dependency @types/jest to version 24.0.15 🌟 (#1776)



Co-authored-by: Renovate Bot <bot@renovateapp.com>

* Add npm-cy to plugins

* Add alias example for cy.request()

* Add Chinese translated titles to docs

* fix(deps): update dependency hexo to version 3.9.0 🌟 (#1777)



Co-authored-by: Renovate Bot <bot@renovateapp.com>

* chore(deps): update dependency snap-shot-it to version 7.7.1 🌟 (#1785)



Co-authored-by: Renovate Bot <bot@renovateapp.com>

* Update debugging.md (#1784)

* update fragment sentence fix to ja/cn docs

* 📝 Include a much simpler TypeScript example (#1745)

* 📝 Include much simple TypeScript example

There was an overload of information in these docs (and example recipes)
and it took me several hours to set-up something that was relatively
simple if it was communicated better. Feel free to fork the repo I
put in the links. Please put something this simple in these docs.

* 👌 Changes according to PR reviewer

Changed typescript to TypeScript

* Fixed bad url tag in reporters page

* Moved Custom Reporters section to bottom the page

To improve usability.

* Added link to Section 9 (reporters) of workshop

* Fixed bad url tag in reporters page
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.