GoogleChrome / GoogleChrome/lighthouse
Update the readme
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 30.8k
- Forks
- 9.8k
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 20
Description
A few things that catch my eye..
- [ ] devtools screenshot needs a refresh
- [ ] Maybe add more a longer description of what Lighthouse does for you.
- [ ] https://developers.google.com/web/tools/lighthouse/ has some updates that the readme doesn't, including the I/O 2019 video.
- [ ] probably can remove the 2018 IO video and perhaps CDS 2018 or 2019 videos are worth adding
- [ ] move "Develop" section almost entirely into contributing.md ?
- [ ] move CLI usage into a CLI.md?
- [ ] Add "Use Lighthouse via PSI API"
- [ ] [stretch] cleanup Integrations/Related Projects _somewhow_
Anything else that others have noticed?
cc @RolandBurrows if you're interested.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the README with the current Lighthouse information at the linked developers.google.com page. Review the README sections, videos, screenshot, CLI usage, integrations, and related projects; done means the agreed updates are reflected and any moved CLI or Develop content has a clear destination.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, cli, content, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100