Add an action to review add-ons in the store by nvdaes · Pull Request #15756 · nvaccess/nvda

nvdaes · 2023-11-07T18:30:41Z

Addan action to review add-ons in the store
Fix linter error and add changelog

Link to issue number:

Closes #15576

Summary of the issue:

The add-on store doesn't have a mechanism to see and provide feedback for add-ons.

Description of user facing changes

Now, it's possible to open a webpage to provide or see feedback for add-ons from an action added to the add-on store.
The review URL is shown in the details panel for add-ons including a reviewUrl in metadata.

Description of development approach

An action has been added to provide feedback for add-ons, in a similar way to the approach followed for the license URL. Also, this has been added to the details panel.

Testing strategy:

Tested manually in English to ensure that "f" shortcut doesn't produce conflicts with other shortcuts in the actions menu.
Ensure that the action is available for Alzaker add-on, which includes a reviewUrl in metadata. Also, ensure that the review URL is shown in the details panel.

Known issues with pull request:

None

Code Review Checklist:

Documentation:
- Change log entry
- User Documentation
- Developer / Technical Documentation
- Context sensitive help for GUI changes
Testing:
- Unit tests
- System (end to end) tests
- Manual testing
UX of all users considered:
- Speech
- Braille
- Low Vision
- Different web browsers
- Localization in other languages / culture than English
API is compatible with existing add-ons.
Security precautions taken.

Adriani90 · 2023-11-07T20:58:17Z

Thanks Noelia for this great work! I think this action and the feedback process from submiting to how the feedback reaches the addon author definitely diserves a sub chapter in the user guide.

nvdaes · 2023-11-09T11:19:58Z

Thank you @Adriani90 . Let's see how to make a subchapter in the user guide. It's not easy since actions aren't described in detail. I'll try to do it.

… reviewUrlAction

nvdaes · 2023-11-09T12:12:48Z

@Adriani90 , I have added a subchapter in the user guide.
I don't know if we should provide examples of some reviews. I suppose that this is not needed, but I ask here in case.
I reviewed Windows App Essentials, reacting with hooray in the discussion (without specifying a version), and left a comment for mathCat 0.3.8, highlighting a feature of this version: the addition of CMU, a braille for math used in Spain and for Portuguese.
I think that this will be ready for review unless you have any other comments.

XLTechie · 2023-11-09T13:50:52Z

@nvdaes, I don't think examples of reviews would be needed. If there need to be suggestions for what people can talk about in reviews, this should be on the discussion page IMO.

nvdaes · 2023-11-09T13:54:25Z

Ok @XLTechie . Then let's mark this as ready for review.

XLTechie · 2023-11-09T13:38:06Z

+++ Reviewing and consulting feedback for add-ons +++[AddonStoreReviews]
+Before installing an add-on, you may want to see opinions and reactions by others.
+Also, you may want to provide feedback about add-ons to help other users.
+To see or share your feedback about add-ons, select an add-on and use the See or provide feedback option in the actions menu.


I really do think that "read" is a better word than "see" for both the option and the usage. Not for any "ableist language" reason, but just because it flows better in English IMO.

Also, for this one, you are not going to "see your feedback", or even "read your feedback"--you are going to either read others' feedback, or leave your own.

Lastly, I think the menu option should be shorter--perhaps just "Reviews". I have only changed the word "see" in the suggestion though.

Suggested change

To see or share your feedback about add-ons, select an add-on and use the See or provide feedback option in the actions menu.

To read what others have said, or share your feedback about add-ons, select an add-on and use the Read or provide feedback option in the actions menu.

XLTechie · 2023-11-09T13:48:04Z

Thanks for adding this to the user guide @nvdaes.
I have left some comments and suggestions for your consideration, to perhaps help it flow better in English.

Co-authored-by: Luke Davis <8139760+XLTechie@users.noreply.github.com>

XLTechie · 2023-11-09T14:10:48Z

@nvdaes, Do you have some unrelated changes in your diff? Like changes to nvWave.py, etc.? GitHub is saying so, the way that I read it.

Co-authored-by: Luke Davis <8139760+XLTechie@users.noreply.github.com>

nvdaes · 2023-11-09T14:16:33Z

@XLTechie , thanks for your useful suggestion.
About diffs, I tried to merge last changes from master. Is not OK?

XLTechie · 2023-11-09T14:30:35Z

@nvdaes Either one of your recent commits fixed it, or there was something odd about the GitHub interface. When I checked out the PR locally after your recent commits, those extra unrelated files weren't showing as changed. So all is fine with that now. Edit: but GitHub is still showing changes to nvWave, braille, touchHandler, and one or two others, as part of your diff, even though git itself doesn't. Very strange.

nvdaes · 2023-11-09T14:34:14Z

@XLTechie wrote:

So all is fine with that now.

Great. Thanks for your valuable comments.

XLTechie · 2023-11-09T14:34:46Z

 						details.sourceURL
 					)

+					if details.reviewUrl is not None:


Shouldn't the "reviewUrl" variable in all of these places, be capitalized the same as "details.sourceURL"?

nvdaes · 2023-11-09T14:37:04Z

Shouldn't the "reviewUrl" variable in all of these places, be capitalized the same as "details.sourceURL"?

I think no since in metadata the variable is set as reviewUrl, and I didn't realise about capitalization, and discussions are created for some add-ons at this moment, and in jsonschema of addon-datastore-validation the variable is also named reviewUrl.

XLTechie · 2023-11-09T14:38:59Z

 			),
+			AddonActionVM(
+				# Translators: Label for an action that opens the webpage to see and send feedback for the selected add-on
+				displayName=pgettext("addonStore", "See or provide &feedback"),


My same comment here as in the documentation: in my opinion this should be "Read", not "See". Or, the entire option should just be called "Reviews"--this menu tends to use short options.

I agree - this should just be "Reviews"

@seanbudd and @XLTechie, "Review" is not suitable IMO:

"Review" may let think to a developer's review. This is more true for add-ons given reviewing add-ons was part of the process to publish add-ons on the old website. This can lead to confusion.

At least in French, I would have difficulty to translate "Review" so that people understand that it is for anybody.

I would prefer the longer but more explicit "Read and provide feedback". But if you stick to something shorter, "Feedback" seems more suitable than "Review".

Of course, an alternative is also to merge the PR as is and wait for feedback from alpha users and translators. The UG and the GUI can be changed later if a more appropriate term is found.

I agree with Cyrille: reviews sounds like the technical procedure for the old website, and feedback is mor understandable, imo, at least in certain languages; anyway imo this shouldn"t prervent to merge this pr.

XLTechie · 2023-11-09T14:40:12Z

+				actionHandler=lambda aVM: startfile(
+					cast(
+						str,
+						cast(_AddonStoreModel, aVM.model).reviewUrl


See my previous suggestion about changing the capitalization of these to "reviewURL", for consistency with other "*URL" variables and fields.

XLTechie · 2023-11-09T14:41:00Z

+				),
+				validCheck=lambda aVM: (
+					isinstance(aVM.model, _AddonStoreModel)
+					and aVM.model.reviewUrl is not None


nvdaes · 2023-11-09T16:28:45Z

@XLTechie I think I've addressed all your comments. Imo, we should use the word feedback, since review may sound as something technical, and feedback seems more user friendly.

nvdaes · 2023-11-09T16:30:26Z

Also, note that see feedback is used in comments for translators since see is shorter than read.

seanbudd · 2023-11-09T22:21:25Z

-		return obj._hasNavigableText
+	if obj._hasNavigableText or isinstance(obj, EditableText):
+		return True
+	return False


these changes should probably be removed in the diff - I imagine merging master in will fix this

seanbudd · 2023-11-09T22:23:05Z

 			),
+			AddonActionVM(
+				# Translators: Label for an action that opens the webpage to see and send feedback for the selected add-on
+				displayName=pgettext("addonStore", "See or provide &feedback"),


I agree - this should just be "Reviews"

seanbudd

There are a large amount of irrelevant changes in this diff. I will re-review from the start once these are resolved.

seanbudd · 2023-11-09T22:23:32Z

 			),
+			AddonActionVM(
+				# Translators: Label for an action that opens the webpage to see and send feedback for the selected add-on
+				displayName=pgettext("addonStore", "Read or provide &feedback"),


Please add an appropriate accelerator key, but this should just be "Reviews"

Suggested change

displayName=pgettext("addonStore", "Read or provide &feedback"),

displayName=pgettext("addonStore", "Reviews"),

seanbudd · 2023-11-09T22:24:02Z

+			# reference to this instance by itself. We don't need to do it explicitly
+			# here. Furthermore, doing it explicitly might cause an exception because
+			# a weakref callback can run before __del__ in some cases, which would mean
+			# it has already been removed from _instances.


same here re merging master to remove this diff

seanbudd · 2023-11-09T22:24:16Z

-			# Ensure we are pumpped again by the time more pending multiTouch trackers are ready
-			self.pendingEmitsTimer.Start(interval*1000,True)
+			# Ensure we are pumped again by the time more pending multiTouch trackers are ready
+			self.pendingEmitsTimer.Start(int(interval * 1000), True)


same here re merging master to remove this diff

nvdaes · 2023-11-09T23:29:31Z

@seanbudd , I've addressed your reviews and removed irrelevant diffs.

seanbudd

I'll review the user guide once we settle on a label for the review action

seanbudd · 2023-11-10T00:50:22Z

 			),
+			AddonActionVM(
+				# Translators: Label for an action that opens the webpage to see and send feedback for the selected add-on
+				displayName=pgettext("addonStore", "Re&views"),


Maybe this could be "Community reviews" to clear the misconception surrounding developer reviews

"User reviews" might be a bit more standard.

I do prefer some usage of "reviews" over "feedback", however--Feedback suggests an interaction between the users/community and the author. Reviews suggest comments meant to be read by other users, at least in the way it's utilized by Amazon, Ebay, Google, etc.

I prefer Community reviews, so that everybody (users, but also developers and others) are encouraged to participate.

Co-authored-by: Sean Budd <seanbudd123@gmail.com>

nvdaes · 2023-11-10T02:24:56Z

@seanbudd I think I've applied all your suggestions for the user guide. I've used the batch option.

seanbudd

Thanks @nvdaes

nvdaes · 2023-11-10T02:37:33Z

Thank you @sean for approving this, and thanks to other reviewers.
I'll request feedback in the add-ons mailing list and in the spanish community when this is merged.

Qchristensen

This will be a well received feature I think. Good work everyone

nvdaes added 2 commits November 7, 2023 06:36

Addan action to review add-ons in the store

e26f6d2

Fix linter error and add changelog

aaa3bac

nvdaes added 2 commits November 9, 2023 12:33

Merge branch 'reviewUrlAction' of https://github.com/nvdaes/nvda into…

58d6336

… reviewUrlAction

Add subchapter in the user guide

03700e3

nvdaes changed the title ~~reviewUrlAction~~ Add a reviewUrl action in the add-on store Nov 9, 2023

nvdaes changed the title ~~Add a reviewUrl action in the add-on store~~ Add an action to review add-ons in the store Nov 9, 2023

nvdaes marked this pull request as ready for review November 9, 2023 13:54

nvdaes requested review from a team as code owners November 9, 2023 13:54

nvdaes requested review from Qchristensen and seanbudd November 9, 2023 13:54

XLTechie suggested changes Nov 9, 2023

View reviewed changes

Update user_docs/en/userGuide.t2t

d92740c

Co-authored-by: Luke Davis <8139760+XLTechie@users.noreply.github.com>

nvdaes and others added 4 commits November 9, 2023 15:12

Update user_docs/en/userGuide.t2t

a9bb947

Co-authored-by: Luke Davis <8139760+XLTechie@users.noreply.github.com>

Update user_docs/en/userGuide.t2t

e7a39dd

Co-authored-by: Luke Davis <8139760+XLTechie@users.noreply.github.com>

Update user_docs/en/userGuide.t2t

694fe3c

Co-authored-by: Luke Davis <8139760+XLTechie@users.noreply.github.com>

Update user_docs/en/userGuide.t2t

5fbe09e

Co-authored-by: Luke Davis <8139760+XLTechie@users.noreply.github.com>

XLTechie reviewed Nov 9, 2023

View reviewed changes

Address review: use read instead of see for feedback

68b41e3

Adress review: use reviewURL instead of reviewURL

32fe0f3

seanbudd reviewed Nov 9, 2023

View reviewed changes

Address review: use Reviews for the adction menu

8d8bd73

nvdaes closed this Nov 9, 2023

nvdaes force-pushed the reviewUrlAction branch from 8d8bd73 to 5cc028b Compare November 9, 2023 23:19

nvdaes reopened this Nov 9, 2023

seanbudd reviewed Nov 10, 2023

View reviewed changes

Update source/gui/_addonStoreGui/controls/details.py

05bcf5f

Co-authored-by: Sean Budd <seanbudd123@gmail.com>

nvdaes requested a review from seanbudd November 10, 2023 01:51

Use Community reviews for the label of reviews action

3c4e849

seanbudd reviewed Nov 10, 2023

View reviewed changes

Comment thread user_docs/en/userGuide.t2t Outdated

Comment thread user_docs/en/userGuide.t2t Outdated

Comment thread user_docs/en/userGuide.t2t Outdated

Comment thread user_docs/en/userGuide.t2t Outdated

Comment thread user_docs/en/userGuide.t2t Outdated

Apply suggestions from code review

72eb92e

Co-authored-by: Sean Budd <seanbudd123@gmail.com>

nvdaes requested a review from seanbudd November 10, 2023 02:26

seanbudd approved these changes Nov 10, 2023

View reviewed changes

Qchristensen approved these changes Nov 10, 2023

View reviewed changes

seanbudd merged commit c4b704a into nvaccess:master Nov 12, 2023

nvaccessAuto added this to the 2024.1 milestone Nov 12, 2023

	To see or share your feedback about add-ons, select an add-on and use the See or provide feedback option in the actions menu.
	To read what others have said, or share your feedback about add-ons, select an add-on and use the Read or provide feedback option in the actions menu.

	displayName=pgettext("addonStore", "Read or provide &feedback"),
	displayName=pgettext("addonStore", "Reviews"),

Uh oh!

Conversation

nvdaes commented Nov 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Link to issue number:

Summary of the issue:

Description of user facing changes

Description of development approach

Testing strategy:

Known issues with pull request:

Code Review Checklist:

Uh oh!

Adriani90 commented Nov 7, 2023

Uh oh!

nvdaes commented Nov 9, 2023

Uh oh!

nvdaes commented Nov 9, 2023

Uh oh!

XLTechie commented Nov 9, 2023 via email

Uh oh!

nvdaes commented Nov 9, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

XLTechie commented Nov 9, 2023

Uh oh!

nvdaes commented Nov 9, 2023

Uh oh!

XLTechie commented Nov 9, 2023 via email • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nvdaes commented Nov 9, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nvdaes commented Nov 9, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nvdaes commented Nov 9, 2023

Uh oh!

nvdaes commented Nov 9, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

seanbudd left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nvdaes commented Nov 9, 2023

Uh oh!

seanbudd left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

nvdaes commented Nov 7, 2023 •

edited

Loading

XLTechie commented Nov 9, 2023 via email •

edited

Loading