-
Notifications
You must be signed in to change notification settings - Fork 9.4k
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
docs(new-audits.md): Docs on new audits #3617
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we want to add something like "What do you propose for the audit's report UI?" or there may be multiple proposals.., but we want to understand this fairly early.
Also... perhaps we could also ask them to provide any links with more information about the particular issue & recommendation.
docs/new-audits.md
Outdated
|
||
*Note: it's possible to submit a new audit proposal for something that you as a contributor feel very passionate about, but the | ||
Lighthouse team feels that it wouldn't add value to a significant portion of the Lighthouse users. In this case, we'd be open to | ||
having your audit be a part of the report when run with the full config on the Command Line. * |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nuke the space before your last * to get the italics
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done!
docs/new-audits.md
Outdated
having your audit be a part of the report when run with the full config on the Command Line. * | ||
|
||
## Process for creating a new audit | ||
- Briefly scan the criteria we’ve laid out above. If you think the principles match with your proposed new audit, then proceed! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lets use numbered bullets for this one instead ? you can just use 1.
every time (and it'll increment)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done!
added Paul changes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Made all the changes, good feedback :)
closes #2624