Skip to content
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

Extends Transition words list for Turkish after user feedback #21616

Open
wants to merge 6 commits into
base: trunk
Choose a base branch
from

Conversation

marinakoleva
Copy link
Contributor

@marinakoleva marinakoleva commented Sep 10, 2024

Context

  • A user suggested more words and phrases that are missing from our list of transition words for Turkish. We investigated all of the suggestions, and added most of them.
  • Additionally, we did some research into missing Turkish transition words, and added a few more entries as well.

Summary

This PR can be summarized in the following changelog entry:

  • Improves the transition words assessment for Turkish and English by expanding the relevant lists of transitions words. Props to abulu.
  • [shopify-seo] Improves the transition words assessment for Turkish and English by expanding the relevant lists of transitions words.
  • [yoastseo] Improves the transition words lists for Turkish and English.

Relevant technical choices:

  • This is the document where the research is saved. It also includes the reasoning behind the removal of a few phrases from the English and Turkish lists.
  • Specifically about the user's suggestions:
    • We are adding the following words and phrases: sayesinde, aksi durumda, üzere, bu durum.
    • We are not adding the following: için, kadar, olup. The reason is that they are words that have many different meanings, most of which don’t fit within the category of “transition word”. Two of them are already recognized when used in specific phrases, e.g. olduğu kadar and bunun için. And for olup we added instead olup olmadığı.
    • We are not adding böylece because it was already part of our list.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • Test site language is English.
  • Open an existing or new post with some English text, and click on the eye button of the Transition words assessment within the Readability tab to find a sentence that doesn't have transition words (that sentence won't be highlighted).
  • Add one of the new transition words/ phrases to the sentence, e.g. according to.
  • Click again on the eye button of the Transition words assessment and confirm that the sentence is now highlighted.
  • Switch the test site language to Turkish.
  • Open a new post (or any other content type) and paste some Turkish text, e.g. this one
  • Add some of the new transition words to sentences which are not highlighted and confirm that the sentences become highlighted/ the percentage of sentences with transition words increases.
    • The assessment in Turkish: Geçiş kelimeleri = Transition words
    • Single-word transition words to test: sayesinde, madem
    • Multiple-word transition words to test (don't add any additional words in between them): aksi durumda, öte yandan
    • Two-part transition words to test (you should split them, e.g. put one of the words in the beginning of the sentence and the other at the end): ne ne, olsun olmasın

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 (Default Block/Gutenberg/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

  • 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:

  • Nothing else.

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. For example, comments in the Relevant technical choices, comments in the code, documentation on Confluence / shared Google Drive / Yoast developer portal, or other.

Quality assurance

  • I have tested this code to the best of my abilities.
  • During testing, I had activated all plugins that Yoast SEO provides integrations for.
  • 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.
  • I have checked that the base branch is correctly set.

Innovation

  • No innovation project is applicable for this PR.
  • This PR falls under an innovation project. I have attached the innovation label.
  • I have added my hours to the WBSO document.

Fixes #21532

@marinakoleva marinakoleva linked an issue Sep 10, 2024 that may be closed by this pull request
@marinakoleva marinakoleva added the changelog: enhancement Needs to be included in the 'Enhancements' category in the changelog label Sep 10, 2024
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know why a lot of the unit tests were commented out in this file, but I wanted to uncomment the Turkish ones, and then decided to do it for all languages.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have no idea as well, but agree! I think these language-specific tests are useful 🙌🏽

@marinakoleva marinakoleva marked this pull request as ready for review September 11, 2024 12:37
@coveralls
Copy link

Pull Request Test Coverage Report for Build 310b9142a36ed2dfbe568c02eb4beb55db4e0c8e

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 49.567%

Totals Coverage Status
Change from base Build c57ccb95b2e11321967993885e7d0768ddeb3b0c: 0.0%
Covered Lines: 25762
Relevant Lines: 53651

💛 - Coveralls

Copy link
Contributor

@FAMarfuaty FAMarfuaty left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the very thorough investigation of the suggested Turkish transition words! And, it's also great to see your proactiveness in making related changes in English too! 🙌🏽

I agree with your observation and reasonings in the document. I left one comment about "if" on its own whether it's a transition word.

About the changelog items, seeing that the changes for English have an impact now on the transition word detection in English, I think that a general changelog item (for the Free plugin) should also be added. The changes are user-facing :)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have no idea as well, but agree! I think these language-specific tests are useful 🙌🏽

@marinakoleva
Copy link
Contributor Author

marinakoleva commented Sep 18, 2024

About the changelog items, seeing that the changes for English have an impact now on the transition word detection in English, I think that a general changelog item (for the Free plugin) should also be added. The changes are user-facing :)

Do I understand correctly that you mean that the changelog should mention that it applies not only to Turkish, but also to English? If so, I agree! I didn't add it because there are only a few changes to the English list, but a change is a change :)

Edit: I updated the changelog entries ✅

@marinakoleva marinakoleva added the Shopify This PR impacts Shopify. label Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog: enhancement Needs to be included in the 'Enhancements' category in the changelog Shopify This PR impacts Shopify.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Check suggested Turkish transition words
3 participants