Skip to content

Add detailed instructions on how to make changes #539

Add detailed instructions on how to make changes

Add detailed instructions on how to make changes #539

Triggered via pull request July 27, 2023 12:13
Status Success
Total duration 53s
Artifacts

linting.yml

on: pull_request
Fit to window
Zoom out
Zoom in

Annotations

8 errors, 5 warnings, and 26 notices
[error] Vale.Terms: docs/channels/emails.rst#L309
Use 'SendGrid' instead of 'Sendgrid'.
[error] Vale.Terms: docs/channels/emails.rst#L307
Use 'SendGrid' instead of 'Sendgrid'.
[error] Vale.Terms: docs/channels/emails.rst#L297
Use 'SendGrid' instead of 'Sendgrid'.
[error] Vale.Terms: docs/channels/emails.rst#L291
Use 'SendGrid' instead of 'Sendgrid'.
[error] Vale.Terms: docs/channels/emails.rst#L278
Use 'PHP' instead of 'php'.
[error] Vale.Terms: docs/channels/emails.rst#L266
Use 'PUT' instead of 'put'.
[error] Vale.Terms: docs/channels/emails.rst#L265
Use 'SMTP' instead of 'smtp'.
[error] Vale.Terms: docs/channels/emails.rst#L256
Use 'SMTP' instead of 'smtp'.
[suggestion] Mautic.FeatureList: docs/channels/emails.rst#L312
Is this referring to a Mautic feature? If so, use 'Plugins' instead of 'plugins'.
[suggestion] Mautic.FeatureList: docs/channels/emails.rst#L312
Is this referring to a Mautic feature? If so, use 'Emails' instead of 'emails'.
[suggestion] Mautic.FeatureList: docs/channels/emails.rst#L312
Is this referring to a Mautic feature? If so, use 'Email' instead of 'email'.
[suggestion] Google.Acronyms: docs/channels/emails.rst#L307
Spell out 'DSN', if it's unfamiliar to the audience.
[suggestion] Google.Passive: docs/channels/emails.rst#L303
In general, use active voice instead of passive voice ('be set').
[suggestion] Google.Acronyms: docs/channels/emails.rst#L297
Spell out 'DSN', if it's unfamiliar to the audience.
[suggestion] Google.Passive: docs/channels/emails.rst#L291
In general, use active voice instead of passive voice ('is mentioned').
[suggestion] Google.Contractions: docs/channels/emails.rst#L291
Use 'that's' instead of 'that is'.
[suggestion] Mautic.FeatureList: docs/channels/emails.rst#L278
Is this referring to a Mautic feature? If so, use 'Form' instead of 'form'.
[suggestion] Google.Acronyms: docs/channels/emails.rst#L278
Spell out 'DSN', if it's unfamiliar to the audience.
[suggestion] Mautic.FeatureList: docs/channels/emails.rst#L275
Is this referring to a Mautic feature? If so, use 'Form' instead of 'form'.
[suggestion] Google.Acronyms: docs/channels/emails.rst#L272
Spell out 'TLS', if it's unfamiliar to the audience.
[suggestion] Google.Passive: docs/channels/emails.rst#L272
In general, use active voice instead of passive voice ('is used').
[suggestion] Google.Acronyms: docs/channels/emails.rst#L263
Spell out 'SMPT', if it's unfamiliar to the audience.
[suggestion] Google.Passive: docs/channels/emails.rst#L263
In general, use active voice instead of passive voice ('are required').
[suggestion] Google.Acronyms: docs/channels/emails.rst#L257
Spell out 'DSN', if it's unfamiliar to the audience.
[suggestion] Mautic.FeatureList: docs/channels/emails.rst#L257
Is this referring to a Mautic feature? If so, use 'Email' instead of 'email'.
[suggestion] Mautic.FeatureList: docs/channels/emails.rst#L257
Is this referring to a Mautic feature? If so, use 'Plugin' instead of 'plugin'.
[suggestion] Google.Parens: docs/channels/emails.rst#L257
Use parentheses judiciously.
[suggestion] Mautic.FeatureList: docs/channels/emails.rst#L257
Is this referring to a Mautic feature? If so, use 'Email' instead of 'email'.
[suggestion] Google.Acronyms: docs/channels/emails.rst#L252
Spell out 'DSN', if it's unfamiliar to the audience.
[suggestion] Google.Acronyms: docs/channels/emails.rst#L245
Spell out 'DSN', if it's unfamiliar to the audience.
[suggestion] Google.Acronyms: docs/channels/emails.rst#L235
Spell out 'DSN', if it's unfamiliar to the audience.
[suggestion] Google.Passive: docs/channels/emails.rst#L235
In general, use active voice instead of passive voice ('is called').
[suggestion] Google.Passive: docs/channels/emails.rst#L228
In general, use active voice instead of passive voice ('be found').
[suggestion] Mautic.FeatureList: docs/channels/emails.rst#L228
Is this referring to a Mautic feature? If so, use 'Plugins' instead of 'plugins'.
[warning] Google.Will: docs/channels/emails.rst#L275
Avoid using 'will'.
[warning] Google.WordList: docs/channels/emails.rst#L263
Use 'preceding' instead of 'above'.
[warning] Google.Will: docs/channels/emails.rst#L257
Avoid using 'will'.
prose
The following actions uses node12 which is deprecated and will be forced to run on node16: actions/checkout@v2. For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default/
build
The following actions uses node12 which is deprecated and will be forced to run on node16: actions/checkout@v2, actions/setup-python@v2. For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default/