New rules to improve the PR review

[molant]

The PR review can take a while, especially for new comers. We should try to automate this process as much as possible and for that I think we should create a few new rules or checks:

• Verify that url is always URL or URLs in the comments (HTML, SVG, PNG, etc.)
• Make sure there's an ending . in the context.report (and maybe debug and comments?)
• Don't use abbreviations (at least in context.report)
• Make sure we use inclusive language, no Just usage, etc. (maybe look into alex, markdown-spellcheck, etc.)
• Code is surrounded by ' in comments.
• Prefer destructuring in the parameters directly. E.g:

- const validate = async (fetchEnd: FetchEnd) => {
-     const { element, resource, response }: { element: IAsyncHTMLElement | null, resource: string, response: Response } = fetchEnd;
+ const validate = async ({ element, resource, response }: FetchEnd) => { 

And some others.

@webhintio/core I'm sure I'm forgetting more things we can catch up early. Can you help?

[alrra]

Verify that url is always URL or URLs in the comments

HTML, SVG, PNG...

Make sure there's an ending . in the context.report (and maybe debug and comments?)

Code is surrounded by '.

[molant]

Added those to the list. Not sure how we will detect code in comments though 🤔 Maybe a list of keywords?

[alrra]

Maybe a list of keywords?

Or when words are camelCase, or have dots and the letter after the dot is lowercase (e.g.: context.something).