Conversation
…oved some details which seemed superfluous to me.
README.md
Outdated
|
|
||
| ### Additional Resources | ||
|
|
||
| - [Prebid Examples](http://prebid.org/dev-docs/getting-started.html) |
There was a problem hiding this comment.
I think this link belongs up near the top of the readme - since the consumer is anyone that is trying to implement prebid.js.
There was a problem hiding this comment.
yeah... I agree, this does make much more sense
CONTRIBUTING.md
Outdated
|
|
||
| ## Pull Requests | ||
| Please make sure that pull requests are scoped to one change, and that any added or changed code includes tests with greater than 80% code coverage. See [Testing Prebid.js](#testing-prebidjs) for help on writing tests. | ||
| Details about the Pull Request process can be found [here](./pr_review.md). |
There was a problem hiding this comment.
hate to have duplicative information, but I feel like stating 80% code coverage is nice to have here, even if it is in the linked doc.
| - You may need to iterate on your code or tests until all tests are passing. | ||
| - Make sure existing tests still pass. | ||
| - There is a table below the testing report that shows code coverage percentage, for each file under the `src` directory. | ||
| - Each time you run tests, a code coverage report is generated in `build/coverage/lcov/lcov-report/index.html`. |
There was a problem hiding this comment.
Think having a link to this report is good to preserve, maybe just add a heading for Test Coverage
There was a problem hiding this comment.
I agree. It's included under "Writing Tests" though.
My thought process was basically "the only time I care about code coverage is when I check to make sure my tests are good anyway."
…d some information about pull requests.
…built * 'master' of https://github.com/prebid/Prebid.js: (23 commits) Increment pre version Probed 0.24.0 Release Beachfront adapter - add ad unit size (prebid#1183) Thoughtleadr adapter - fix postMessage (prebid#1207) When prebid server issues a no-bid response, call addBidResponse for every adUnit requested (prebid#1204) Improvement/timeout xhr (prebid#1172) Add native support (prebid#1072) Improvement/alias queue (prebid#1156) Updated documentaion (prebid#1160) Improvement/prebid iframes amp pages (prebid#1119) Fixes prebid#1114 possible xss issue (prebid#1186) Allowed setTargetingForGPTAsync() to target specific ad unit codes. (prebid#1158) updated tag (prebid#1212) Common user-sync (prebid#1144) Rename secureCreatives file and lint (prebid#1203) HIRO Media: Remove batching mechanism and use AJAX instead of JSONP (prebid#1133) Add Support for DigiTrust in Rubicon Adapter (prebid#1201) Upgrade linters to ESLint with stricter code style (prebid#1111) Add dynamic bidfloor parameter to Smart Adserver Adapter (prebid#1194) Bug fix: bids served by secure creatives does not get pushed into _winningBids (prebid#1192) ...
….23.0 to aolgithub-master * commit '136fc37637749a764070c35c03e7e87a5c157947': (33 commits) Added changelog entry. Implemented passing key values feature. Update code to ESlint rules. Prebid 0.24.1 Release tests: drop ie9 browserstack test Audience Network: separate size from format (prebid#1218) Bugfix/target filtering api fix (prebid#1220) Map sponsor request param to endpoint param (prebid#1219) Increment pre version Probed 0.24.0 Release Beachfront adapter - add ad unit size (prebid#1183) Thoughtleadr adapter - fix postMessage (prebid#1207) When prebid server issues a no-bid response, call addBidResponse for every adUnit requested (prebid#1204) Improvement/timeout xhr (prebid#1172) Add native support (prebid#1072) Improvement/alias queue (prebid#1156) Updated documentaion (prebid#1160) Improvement/prebid iframes amp pages (prebid#1119) Fixes prebid#1114 possible xss issue (prebid#1186) Allowed setTargetingForGPTAsync() to target specific ad unit codes. (prebid#1158) ...
Type of change
Description of change
Removed some duplicate docs by linking the .md files together. Added a link to Karma, which is part of the testing tech stack.
More controversially: Deleted a chunk of docs which... honestly just made my eyes glaze over when I read them. I would place "how to fix unit tests" and "how to use a code coverage report" a bit outside of the scope of Prebid. Even Istanbul just links you to a sample report without any more real explanation.