stevedlawrence commented on a change in pull request #22:
URL: https://github.com/apache/daffodil-vscode/pull/22#discussion_r727030308
##########
File path: package.json
##########
@@ -1,13 +1,11 @@
{
"name": "daffodil-debugger",
- "displayName": "Daffodil Debugger",
+ "displayName": "Apache Daffodil Debugger Extension",
+ "description": "VS Code extension for Apache Daffodil Schema Debugger",
"version": "1.0.0",
- "publisher": "jw3",
- "description": "Daffodil Schema Debugger: debug DFDL schema files using
Apache Daffodil.",
+ "publisher": "asf",
+ "author": "Apache Daffodil",
"license": "Apache-2.0",
Review comment:
I usually use `Apache License, Version 2.0`, since this is what
https://www.apache.org/licenses/LICENSE-2.0 uses.
##########
File path: README.md
##########
@@ -26,11 +26,11 @@ This is a VS Code extension which enables the interactive
debugging of DFDL sche
## Installation
-Until the extension is available in the [VS Code Extension
Marketplace](https://marketplace.visualstudio.com/vscode), please download the
latest `.vsix` file from the [releases
page](https://github.com/jw3/example-daffodil-vscode/releases). Then install it
by either:
+Until the extension is available in the [VS Code Extension
Marketplace](https://marketplace.visualstudio.com/vscode), please download the
latest `.vsix` file from the [releases
page](https://github.com/apache/daffodil-vscode/releases). Then install it by
either:
* using the "Extensions: Install from VSIX" command from within VS Code
(open the Command Palette with Shift-Command-P, then type `vsix` to bring up
the command and pointing it at the downloaded `vsix` file); or
* on the command-line via `code --install-extension
<path-to-downloaded-vsix>`.
## Usage
-Please refer to the Wiki page at
https://github.com/jw3/example-daffodil-vscode/wiki
+Please refer to the Wiki page at https://github.com/apache/daffodil-vscode/wiki
Review comment:
No where in the README are there build dependencies or instructions.
Apache is very source code focused, so instructions should first and foremost
be about how to build things from source. It's fine to also provide convenience
binaries, whether they be from downloads.apache.org or via the marketplace, but
that's importtation information that should be in this README. It doesn't need
to be part of this PR, but a new issue should be opened to add that information.
##########
File path: package.json
##########
@@ -1,13 +1,11 @@
{
"name": "daffodil-debugger",
- "displayName": "Daffodil Debugger",
+ "displayName": "Apache Daffodil Debugger Extension",
Review comment:
Could the name be changed to make it more clear this is about debugging
schemas? With this name, it sounds like it's used for debugging Apache
Daffodil, which isn't the main focus of the tool. Maybe something like "DFDL
Schema Debugger Extension" or "Apache Daffodil DFDL Schema Debugger Extension",
though that's a bit long. Maybe this is fine and the description can be used to
clarify it's for schema debugging?
##########
File path: package.json
##########
@@ -1,13 +1,11 @@
{
"name": "daffodil-debugger",
- "displayName": "Daffodil Debugger",
+ "displayName": "Apache Daffodil Debugger Extension",
+ "description": "VS Code extension for Apache Daffodil Schema Debugger",
Review comment:
Seems `VSCode` without the space is the common way to refer to Visual
Studio Code? I would also refer it as ` `DFDL Schema Debugger`, just to make it
clear that these are Apache Daffodil schemas, they are DFDL Schemas, and the
ebugger is powered by Apache Daffodil.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
