Contributing guidelines

[hhkaos]

First of all, congrats for this awesome repository :), I would love to contribute but I have no previous experience developing VSCode extensions.

I'm using a Mac, so I have modified the file at ' ~/.vscode/extensions/esri.arcgis-jsapi-snippets-1.1.2/snippets/javascript.json' but I don't know how I can test if it's properly working. How do I do it? Do I need to refresh/reload the extension?

Thanks!!

Note: I would be nice to include the readme / contributing.md simple instructions on how to do it.

[hhkaos]

I just found that adding a "prefix" and with Cmd+Shift+P -> "Developer: Reload Window" just works :)

[hhkaos]

One question, do you think it could make sense to add the following resources to the contributing.md:

• Snippets in Visual Studio Code
• Your First Extension | Visual Studio Code Extension API
• JS IntelliSense in VSCode
• IntelliSense in VSCode

I would be welcome to add a PR if you think so :).

// cc: @RalucaNicola, @andygup , @kellyhutchins, @ekenes

[RalucaNicola]

that sounds like a good idea to me!

[hhkaos]

Great, I'll add it then 😄 .

One more question, do you recommend me to link then snippets in the ~/.vscode/extensions with the snippets on this repo?, or do you just use a developer version of the snippet in local to avoid conflicts?

[RalucaNicola]

my workflow is usually to test them locally, just by adding them to the user snippets files (Cmd + P >Preferences: Configure user snippets, pick the language and add the snippet in there. If it's good, then I add it to this repo and I check it out once it's published. Then I usually remove the snippets from the local file.

I am not very proficient in this though, so there are for sure better ways to test the snippets before adding them to production.

[hhkaos]

Cool! I didn't know about the "Cmd + P >Preferences: Configure user snippets" either! 😅 , that another easy way to test snippets 👍 .

Anyway, I have also to install the VSIX from local (thinking that it might link the original folder):

But it makes a copy of the folder, then ask me to update to 1.1.2 and do another copy:

And of course, none of those folders are identical to the original, so... I will wait for @kellyhutchins 😄 .

Thanks one more time!!

[kellyhutchins]

I always test snippets locally using the same steps as Raluca outlines above. Installing from .vsix is just another way to install the existing published extension. I will work on updating and publishing the updated extension to marketplace this week. Thanks for your contributions!

[hhkaos]

Thank you! I just did my PR so I'm going to close this 😉