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

Improve base grammar #20

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

RCheesley
Copy link

💡Background

As a user I found the terminology used in the module quite confusing, and difficult to understand, as some of the terminology wasn't really using the words or phrases that I'd expect.

🤔 Ideas for improvement

In this PR I've made several proposals which I think make the spam module more understandable for the regular user.

Some of this is fixing typos, but some is changing the actual wording used to describe things, to something which I think might be a bit more familiar.

I think that these all make sense in the context, but some I could not find in the UI directly so I am just working on assumptions.

🔄 Changes proposed

  1. Consistency, e.g. always using TLDs rather than TLDs and tlds.

  2. Typos - in a few places there were extra letters or words which were mis-spelled which I've fixed.

  3. Adding a note that the admin will still need to manually block the user.

  4. Using their instead of its when referring to the user.

  5. Avoid the -> Don't allow the (it makes better grammatical sense, I think).

  6. Instead of saying what happened (word matches with dictionary), I changed it to what this means (forbidden word found, forbidden domain extension found) which I feel as a user makes more sense, because I can directly understand the impact.

  7. Clarity in the fact that the user gets an email about their account being locked.

  8. An error occurs -> An error occurred (better grammatical sense).

  9. Making more of a sentence, instead of 'when spam', use 'when spam content is detected' - explains what is actually happening (spam is found in the content submitted).

  10. I think that instead of 'agent', which doesn't make a lot of sense to me as a user, perhaps using the word 'trigger' would be better? It informs them directly what that does, whereas agent is a bit unclear (do you mean a secret agent🕵🏻? an estate agent🏠?) whereas trigger is explaining what that thing actually does (trigger, or not, the actions to take place) - e.g. 'fire spam trigger if rules match' sounds clearer to me than 'fire spam agent if rules match'.

  11. I think 'detection symbols' is also a bit confusing, perhaps 'triggers' is better? e.g. Check the trigger/s required to fire the rules rather than Check the detection symbols required to fire the rules.

😱Things I could not find to correct

  1. Dictionnary is mis-spelled several times, but it's not in this file - I would probably change it to 'Block list' and change 'Dictionnary configurations' to 'Block list configuration'

  2. 'Sinalize' is not at all a common term in English, but I can't find where to change this - perhaps it's a core language string?

  3. List forbidden words -> List of forbidden words

  4. 'Remove scan' on the button when in a dictionary setting - I'd say 'remove block list'

Hope that this might be helpful!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant