Add docs for reasonable configuration of lighthouse config

Open
  • Is something wrong?
#214 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
json, typescript
Domain
devtools, documentation

Research direction

Read the project documentation and configuration examples to find where Lighthouse settings and budgets are described. Add examples for global, flow, and step level configurations and budgets, explaining how each level affects a flow; done means all six requested examples and their effects are covered.

Written by the indexing model from the issue text.

Description

documentation

Configurations can be defined in different levels. This issue should give examples and explain them.
Configurations can be enriched or reduced or changed.

LH Configuration

  • Define an example for a global LH configuration 
    {
  "settings": {
    "onlyCategories": ["performance"]
  } 
}
    This would only run audits of the performance category in every flow and in each flow in each step
  • Define and example for a flow LH based configuration 
    {
 "settings": {
   "formFactor": "desktop",
   "throttling": "constants.throttling.desktopDense4G",
   "screenEmulation": "constants.screenEmulationMetrics.desktop",
   "emulatedUserAgent": "constants.userAgents.desktop",
 }
}
    This will run only one specific audit for a flow.
  • Define an example for a step LH based configuration 
    {
 "settings": {
    "skipAudits": ["full-page-screenshot"],
 } 
}

LH Budget

  • Define an example for a global LH budget
  • Define and example for a flow LH budget
  • Define an example for a step LH budget
Dominant language
HTML
Stars
131
Forks
7
Avg merge
7h 58m
Merged PRs (30d)
42

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from push-based/user-flow

All issues in push-based/user-flow

Similar issues

More DevTools issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.