Feature/should haves for inclusive language by agnieszkaszuba · Pull Request #19378 · Yoast/wordpress-seo

agnieszkaszuba · 2022-12-12T15:47:15Z

Context

This PR includes a number of improvements to the inclusive language analysis.
Note that this PR was set to non-user facing as the changelog generator had issues with the list. The items have been added manually to the user-facing changes in the changelog.

Summary

This PR can be summarized in the following changelog entry:

Improves the inclusive language analysis by expanding the number of non-inclusive phrases recognized as well as by improving the feedback, for example by adding more inclusive alternatives or fixing inconsistencies. Specifically, this includes the following changes:
- Adds "OCD", "normal" and "abnormal" to the terms that are targeted by the inclusive language analysis in specific contexts.
- Adds "stupid" to the terms that are always targeted by the inclusive language analysis.
- Removes the term "African American Vernacular English" from the terms targeted by the inclusive language analysis.
- Changes the terms "exotic" and "oriental" to be considered potentially non-inclusive in the inclusive language analysis, adds exceptions and updates their feedback.
- Improves the categorization of the targeted terms in the inclusive language analysis by splitting the other category into a more specific one.
- Improves the feedback for some (potentially) non-inclusive target terms in the inclusive language analysis.
- Adds more alternatives to some (potentially) non-inclusive target terms in the inclusive language analysis.
- Adds terms that are only considered (potentially) non-inclusive when they are followed by certain words or a punctuation mark.

Relevant technical choices:

Includes changes from the following PRs:

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

Smoke test the inclusive language analysis.

Relevant test scenarios

Changes should be tested with the browser console open
Changes should be tested on different posts/pages/taxonomies/custom post types/custom taxonomies
Changes should be tested on different editors (Block/Classic/Elementor/other)
Changes should be tested on different browsers
Changes should be tested on multisite

Test instructions for QA when the code is in the RC

For RC testing, refer to the testing instructions in the individual PRs linked above.
QA should use the same steps as above.

QA can test this PR by following these steps:

Impact check

This PR affects the following parts of the plugin, which may require extra testing:

UI changes

This PR changes the UI in the plugin. I have added the 'UI change' label to this PR.

Other environments

This PR also affects Shopify. I have added a changelog entry starting with [shopify-seo], added test instructions for Shopify and attached the Shopify label to this PR.

Documentation

I have written documentation for this change.

Quality assurance

I have tested this code to the best of my abilities
I have added unit tests to verify the code works as intended
If any part of the code is behind a feature flag, my test instructions also cover cases where the feature flag is switched off.
I have written this PR in accordance with my team's definition of done.

Innovation

No innovation project is applicable for this PR.
This PR falls under an innovation project. I have attached the innovation label and noted the work hours.

Fixes https://yoast.atlassian.net/browse/PC-1036

…dByParticiple.js.

…, participle or punctuation.

…vePunctuation.js Co-authored-by: Hans-Christiaan Braun <hans-christiaan@yoast.com>

Co-authored-by: Hans-Christiaan Braun <hans-christiaan@yoast.com>

…unctionWords.js Co-authored-by: Hans-Christiaan Braun <hans-christiaan@yoast.com>

…improve readbility and actionability

…7-target-phrases-based-on-function-words-participles-and-or-punctuation-marks

…ve-phrases PC-981 Adds 'stupid' to non-inclusive phrases

…mprove-categorization-of-inclusive-language-phrases

…fat-and-obese Inclusive language should haves: adapt feedback for 'fat' and 'obese'.

…mprove-categorization-of-inclusive-language-phrases

…25-dont-target-the-minority

…hould-haves-for-inclusive-language

PC-1025 Don't target 'the minority'

…com:Yoast/wordpress-seo into PC-978-add-normal-and-abnormal-to-non-inclusive-phrases # Conflicts: # packages/yoastseo/spec/scoring/assessments/inclusiveLanguage/configuration/otherAssessmentsSpec.js # packages/yoastseo/src/scoring/assessments/inclusiveLanguage/configuration/otherAssessments.js

…com:Yoast/wordpress-seo into PC-1015-improve-categorization-of-inclusive-language-phrases # Conflicts: # packages/yoastseo/spec/scoring/assessments/inclusiveLanguage/configuration/appearanceAssessmentsSpec.js # packages/yoastseo/spec/scoring/assessments/inclusiveLanguage/configuration/otherAssessmentsSpec.js # packages/yoastseo/src/scoring/assessments/inclusiveLanguage/configuration/sesAssessments.js

…o-non-inclusive-phrases Add phrases with normal and abnormal to non-inclusive phrases

…com:Yoast/wordpress-seo into PC-1015-improve-categorization-of-inclusive-language-phrases # Conflicts: # packages/yoastseo/spec/scoring/assessments/inclusiveLanguage/configuration/otherAssessmentsSpec.js # packages/yoastseo/src/scoring/assessments/inclusiveLanguage/configuration/otherAssessments.js

…f-inclusive-language-phrases PC-1015 Improve categorization of inclusive language phrases

…com:Yoast/wordpress-seo into PC-1021-non-inclusive-phrases-containing-punctuation-are-not-recognized

…ntaining-punctuation-are-not-recognized inclusive language should haves: fix unreleased bug that phrases with hyphens were not recognized

…hould-haves-for-inclusive-language

hdvos and others added 30 commits November 14, 2022 10:58

Replace inclusivePhrases with the more accurate nonInclusivePhrases

c82df72

add list of function words for inclusive language analysis.

8cc3670

add isNotFollowedByException function

0fe5e83

Adapt getWords with posibility not to remove punctuationmarks.

afaa099

Export punctuation regex string for use in getWords

9edb9b4

put participle recognizing regex in central place to use in isFollowe…

cf76b2f

…dByParticiple.js.

dont remove punctuation in getWords for inclusive language assessment.

40ae1ff

fix mistake in isParticiple

33a4588

Add new inclusive language assessments when followed by function word…

81f972b

…, participle or punctuation.

add spec for isFollowedByException

eb9cc16

add spec for getwords if doRemovePunctuation is false.

b33f016

add specs

3eccb9c

small fixes

3f55d6e

add specs for isFollowedByParticiple

b1488b5

fix error in isFollowedByException that functioned reversely.

469d080

rename variable

f5d3bec

Small improvements based on HC's CR.

480a8a1

Update packages/yoastseo/src/languageProcessing/helpers/sanitize/remo…

62d5644

…vePunctuation.js Co-authored-by: Hans-Christiaan Braun <hans-christiaan@yoast.com>

Update packages/yoastseo/src/languageProcessing/helpers/word/getWords.js

a1ae628

Co-authored-by: Hans-Christiaan Braun <hans-christiaan@yoast.com>

Update packages/yoastseo/src/languageProcessing/helpers/word/getWords.js

ed3a8dc

Co-authored-by: Hans-Christiaan Braun <hans-christiaan@yoast.com>

Update packages/yoastseo/src/languageProcessing/languages/en/config/f…

41a8eaa

…unctionWords.js Co-authored-by: Hans-Christiaan Braun <hans-christiaan@yoast.com>

Fix linting erros.

f7ba5c6

remove AAVE term from targeted phrases

acde2df

edit the configuration and feedback of two appearance assessments to …

98d5cd4

…improve readbility and actionability

Merge branch 'trunk' into feature/should-haves-for-inclusive-language

9f8f2da

implement single rule function

6a5a051

Merge branch 'feature/should-haves-for-inclusive-language' into PC-24…

f90bb29

…7-target-phrases-based-on-function-words-participles-and-or-punctuation-marks

Solve some post merging funkyness.

93716c8

Apply notInclusiveWhenStandalone

f34c4d8

add jsdoc.

f4cf682

hdvos and others added 18 commits December 8, 2022 13:05

Merge pull request #19338 from Yoast/PC-981-add-stupid-to-non-inclusi…

d8fbd9a

…ve-phrases PC-981 Adds 'stupid' to non-inclusive phrases

Removes 'the minority' as a target phrase.

beafe7b

Merge branch 'trunk' of github.com:Yoast/wordpress-seo into PC-1015-i…

d8ecd51

…mprove-categorization-of-inclusive-language-phrases

Removes unused imports

d724413

Merge pull request #19291 from Yoast/PC-968-edit-feedback-string-for-…

156eae3

…fat-and-obese Inclusive language should haves: adapt feedback for 'fat' and 'obese'.

Merge branch 'trunk' of github.com:Yoast/wordpress-seo into PC-1015-i…

25e8439

…mprove-categorization-of-inclusive-language-phrases

Merge branch 'feature/should-haves-for-inclusive-language' into PC-10…

b8efc52

…25-dont-target-the-minority

Merge branch 'trunk' of github.com:Yoast/wordpress-seo into feature/s…

3ef7993

…hould-haves-for-inclusive-language

fix some merging quirkyness.

8b7dce8

Merge pull request #19374 from Yoast/PC-1025-dont-target-the-minority

22fe53d

PC-1025 Don't target 'the minority'

Add back imports after merge conflict

d246b9d

fix merge conflict

9bf8771

Merge pull request #19354 from Yoast/PC-978-add-normal-and-abnormal-t…

20a9649

…o-non-inclusive-phrases Add phrases with normal and abnormal to non-inclusive phrases

fix failing unit test

9ad47a4

Merge pull request #19349 from Yoast/PC-1015-improve-categorization-o…

e0e76cb

…f-inclusive-language-phrases PC-1015 Improve categorization of inclusive language phrases

agnieszkaszuba added this to the 19.13 milestone Dec 12, 2022

agnieszkaszuba added the changelog: enhancement Needs to be included in the 'Enhancements' category in the changelog label Dec 12, 2022

iolse and others added 3 commits December 12, 2022 17:11

Merge branch 'feature/should-haves-for-inclusive-language' of github.…

0917194

…com:Yoast/wordpress-seo into PC-1021-non-inclusive-phrases-containing-punctuation-are-not-recognized

Merge pull request #19355 from Yoast/PC-1021-non-inclusive-phrases-co…

7ea7c98

…ntaining-punctuation-are-not-recognized inclusive language should haves: fix unreleased bug that phrases with hyphens were not recognized

Merge branch 'trunk' of github.com:Yoast/wordpress-seo into feature/s…

eeadc29

…hould-haves-for-inclusive-language

FAMarfuaty merged commit aaf1531 into trunk Dec 13, 2022

FAMarfuaty deleted the feature/should-haves-for-inclusive-language branch December 13, 2022 09:58

enricobattocchi modified the milestones: 19.13, 19.14 Dec 13, 2022

manuelaugustin added changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog and removed changelog: enhancement Needs to be included in the 'Enhancements' category in the changelog labels Dec 20, 2022

mhkuu mentioned this pull request Jan 20, 2023

Merge the inclusive language improvements to trunk #19672

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/should haves for inclusive language#19378

Feature/should haves for inclusive language#19378
FAMarfuaty merged 148 commits intotrunkfrom
feature/should-haves-for-inclusive-language

agnieszkaszuba commented Dec 12, 2022 •

edited by hdvos

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

Conversation

agnieszkaszuba commented Dec 12, 2022 • edited by hdvos Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Context

Summary

Relevant technical choices:

Test instructions

Test instructions for the acceptance test before the PR gets merged

Relevant test scenarios

Test instructions for QA when the code is in the RC

Impact check

UI changes

Other environments

Documentation

Quality assurance

Innovation

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

agnieszkaszuba commented Dec 12, 2022 •

edited by hdvos

Loading