docs(contributing): add tips for audit and gatherer PRs #10690
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
brendankenny
commented
May 1, 2020
| @@ -8,59 +8,40 @@ We tag issues that are good candidates for those new to the code with [`good fir | |||
|
|
|||
| ## Follow the coding style | |||
|
|
|||
| The `.eslintrc` file defines all. We use [JSDoc](http://usejsdoc.org/) with [TypeScript](https://github.com/Microsoft/TypeScript/wiki/JSDoc-support-in-JavaScript). Annotations are encouraged for all contributions. | |||
|
|
|||
| ## Pull request titles | |||
There was a problem hiding this comment.
this, CLA, and "Adding Images to a Readme" sections were just moved down the page
| ## Contributing a patch | ||
|
|
||
| If you have a contribution for our [documentation](https://web.dev/learn/#lighthouse), please submit it in the [web.dev repo](https://github.com/GoogleChrome/web.dev). | ||
|
|
||
| 1. Submit an issue describing your proposed change to the repo in question. |
| dbw_tester.html. To update this file, start a local server on port `8080` and serve the directory `lighthouse-cli/test/fixtures`. Then run: | ||
|
|
||
| ```sh | ||
| npm run start -- --output=json --output-path=lighthouse-core/test/results/sample_v2.json http://localhost:8080/dobetterweb/dbw_tester.html |
connorjclark
approved these changes
May 1, 2020
|
Cool! Thanks for using that feedback! I think it explains things really well now |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
based on the questions in #10662 (comment)
I've tried to update
CONTRIBUTINGa bit to hopefully capture that and removed some outdated advice. As with all docs updates obviously we could have much more here to help contributors, but happy to bikeshed about what's actually here without expanding scope much :)@umaar it would be great if you get a chance to look at this and had any advice as well.