Update readme#1
Merged
Merged
Conversation
nvdaes
commented
Jan 9, 2020
Contributor
- Screen reader users may be more comfortable using a local editor or PR or issue templates instead of editing a file on GitHub.
- installTasks with onInstall() function may need to be skypped at installation in appveyor if input is required at installation.
* Screen reader users may be more comfortable using a local editor or PR or issue templates instead of editing a file on GitHub. * installTasks with onInstall() function may need to be skypped at installation in appveyor if input is required at installation.
feerrenrut
reviewed
Jan 10, 2020
|
|
||
| Process: | ||
| 1. Addon author creates a new Pull Request (PR) on the 'NVDA-Addon-submission' repository. In most cases this could be done with the web editor: | ||
| 1. Addon author creates a new Pull Request (PR) on the 'NVDA-Addon-submission' repository. This could be done with the web editor, though screen reader users may be more comfortable making it locally with their chosen editor or using a provided template: |
Contributor
There was a problem hiding this comment.
Perhaps this should be expanded to include plans for submitting via an issue? If we do that, then I would remove the instructions for how to edit the file, this becomes the 'advanced' workflow for people familiar with the concepts.
Contributor
Author
There was a problem hiding this comment.
I think it would be easier to send issues and remove instructions to edit the file.
| Using a separate repository for this data store separates concerns, gives greater flexibility for managing permissions, makes it easier to verify changes (eg in a PR, or via automation), and simplifies the commit history (no automation commits "updating data store") | ||
|
|
||
| The the exact implementation details for this repository are not exposed to users, because on one side the 'NVDA-Addon-submission' repository feeds data in and the NV Access server is on the other side fetching and providing data to NVDA or a web based store. | ||
| The exact implementation details for this repository are not exposed to users, because on one side the 'NVDA-Addon-submission' repository feeds data in and the NV Access server is on the other side fetching and providing data to NVDA or a web based store. |
Contributor
Author
|
I will made the requested changes the next week, when I have a computer, not just mobile.
Enviado desde mi iPhone
… El 10 ene 2020, a las 10:42, Reef Turner ***@***.***> escribió:
@feerrenrut commented on this pull request.
In README.md:
> @@ -105,7 +105,7 @@ Pre-requisites:
- The commit which will be submitted must be a valid NVDA `*.nvda-addon` file if zipped and renamed.
Process:
-1. Addon author creates a new Pull Request (PR) on the 'NVDA-Addon-submission' repository. In most cases this could be done with the web editor:
+1. Addon author creates a new Pull Request (PR) on the 'NVDA-Addon-submission' repository. This could be done with the web editor, though screen reader users may be more comfortable making it locally with their chosen editor or using a provided template:
Perhaps this should be expanded to include plans for submitting via an issue? If we do that, then I would remove the instructions for how to edit the file, this becomes the 'advanced' workflow for people familiar with the concepts.
In README.md:
> @@ -150,7 +150,7 @@ Holds meta-data about addons accepted to the store.
Using a separate repository for this data store separates concerns, gives greater flexibility for managing permissions, makes it easier to verify changes (eg in a PR, or via automation), and simplifies the commit history (no automation commits "updating data store")
-The the exact implementation details for this repository are not exposed to users, because on one side the 'NVDA-Addon-submission' repository feeds data in and the NV Access server is on the other side fetching and providing data to NVDA or a web based store.
+The exact implementation details for this repository are not exposed to users, because on one side the 'NVDA-Addon-submission' repository feeds data in and the NV Access server is on the other side fetching and providing data to NVDA or a web based store.
Good catch.
In README.md:
> @@ -119,7 +119,7 @@ Process:
- Check manifest validity
- Provide links to relevant diffs
- Check to see if the GitHub user submitting the PR is a maintainer of the Addon version being submitted.
- - On Appveyor CI, install most recently supported version of NVDA supported by addon, install the addon, restart NVDA and check for errors.
+ - On Appveyor CI, install most recently supported version of NVDA supported by addon, install the addon, restart NVDA and check for errors. If the add-on contains an `installTasks.py` file with an `onInstall()` function which may require input at installation, the `installTasks` file may be skypped to avoid false errors.
I'd prefer not to get into the details of things like this, it's really not core to the proposal, and really just a suggestion of the "type" of things that could be done. Perhaps instead it should just be made more clear that this is a "suggestion".
⬇️ Suggested change
- - On Appveyor CI, install most recently supported version of NVDA supported by addon, install the addon, restart NVDA and check for errors. If the add-on contains an `installTasks.py` file with an `onInstall()` function which may require input at installation, the `installTasks` file may be skypped to avoid false errors.
+ - Suggestion: On Appveyor CI, install most recently supported version of NVDA supported by addon, install the addon, restart NVDA and check for errors.
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub, or unsubscribe.
|
Co-Authored-By: Reef Turner <feerrenrut@users.noreply.github.com>
Contributor
Author
|
@feerrenrut, I think that all changes have been applied |
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.