docs(new-audits): revise issue template #6233
Conversation
docs/new-audits.md
Outdated
| - How would passing/failing be defined? | ||
| #### How is this audit different from existing ones? | ||
| #### What % of developers/pages will this impact? | ||
| _(Estimates OK, data points preferred)_ |
There was a problem hiding this comment.
put <!--comments--> around this instead of italics?
docs/new-audits.md
Outdated
| #### What % of developers/pages will this impact? | ||
| _(Estimates OK, data points preferred)_ | ||
| #### How is the new audit making a better web for end users? | ||
| _(Data points preferred)_ |
There was a problem hiding this comment.
put <!--comments--> around this instead of italics?
docs/new-audits.md
Outdated
| - How would passing/failing be defined? | ||
| #### How is this audit different from existing ones? | ||
| #### What % of developers/pages will this impact? | ||
| _(Estimates OK, data points preferred)_ |
There was a problem hiding this comment.
_? Trying to format or something else?
There was a problem hiding this comment.
In the gh issue they would paste this into this would show up as _italics_
There was a problem hiding this comment.
oh I see. Yeah that is confusing if you aren't copy/pasting :)
docs/new-audits.md
Outdated
| ``` | ||
| #### Provide a basic description of the audit | ||
| #### How would the audit appear in the report? | ||
| - What detailed info is shown in all cases, or just failure cases? |
There was a problem hiding this comment.
this is a weird way of phrasing this, but I don't have a great alternative that's also short. What's the goal here?
- what are all the possible states (pass and fail) of the test results
- what information should be shown in each case to help the user improve
?
(but phrased better :)
| If the details are tabular, what are the columns? | ||
| If not obvious, how would passing/failing be defined? --> | ||
| #### How is this audit different from existing ones? | ||
| #### What % of developers/pages will this impact? |
There was a problem hiding this comment.
FWIW I've always thought this one is a weaker version of what we really want to know here which is "What is the global total impact of this audit?" An audit that affects 100% of developers so insignificantly that no one will notice is not as good as an audit that affects half and has a huge impact to each.
There was a problem hiding this comment.
Yeah, the pro/con weighting for it is also different than it once was because now we have notApplicable and can just hide it, so visual noise is less of an issue (though still a concern in the limit). Now it's more maintenance/run time cost as the potential negative.
there was some nonsense in here about the "full config". But I also wanted to prioritize defining what it looks like in the report.