Organizing code to be easier to follow (microsoft#24332)

* Organizing code to be easier to follow * Adding back trampled readme changes
kevchant · Sep 7, 2023 · 51f84ee · 51f84ee
1 parent b70f6ad
commit 51f84ee
Show file tree

Hide file tree

Showing 3 changed files with 233 additions and 217 deletions.
diff --git a/samples/sqlservices/README.md b/samples/sqlservices/README.md
@@ -11,4 +11,13 @@ This is a sample extension that will show some basic model-backed UI scenarios a
 - `yarn build` - to build the code
 - Launch VSCode and open the azuredatastudio's code folder, run the 'Launch azuredatastudio' debug option (to work around the issue. The next step won't work without doing this first)
 - Launch VSCode and open this folder, run the 'Debug in enlistment'.  To debug, [install the `sqlops-debug` extension](https://github.com/Microsoft/azuredatastudio/wiki/Debugging-an-Extension-with-VS-Code) in VS Code.
-- Once ADS launches, you should be able to run the sqlservices commands, for example: sqlservices.openDialog
+- Launch VSCode and open this folder, run the 'Debug in enlistment'
+- Once ADS launches, you should be able to run the sqlservices commands, for example: `sqlservices.openDialog`.
+
+## Consuming `azdata` typing changes during development
+If writing samples for new component model UI components that aren't yet checked into main, change the URL specified in `sqlservices\tasks\buildtasks.js`'s `copytypings` task to point to the branch with the `azdata.proposed.d.ts` changes.  Because this task pulls the `azdata.proposed.d.ts` type from this URL, your changes must be pushed to your branch before this will work.  It does not use the local files.
+
+After running `yarn build`, you should see your updated typings in `sqlservices\typings\azdata.proposed.d.ts`.
+
+> **Important**
+> Do not check in changes to this URL to `main`.  This is for development only; revert these changes before they are sent out in a PR.