Sp-dev-fx-webparts: Include VSCode remote/codespace configuration in repository

[pschaeflein]

Sample

Entire repo

Authors

@hugoabernier

Expected or Desired Behavior

Visual Studio Codespaces provides for configuring an environment using files in the referenced repository. I believe it would be help to configure this repo. The steps are document on my blog at https://www.schaeflein.net/using-visual-studio-codespaces-for-spfx-development/.

If approved, I am happy to have this issue assigned to me.

[msftbot[bot]]

Thank you for reporting this issue. We will be triaging your incoming issue as soon as possible.

[hugoabernier]

Hey @pschaeflein how would you feel about adding instructions how to open the samples in VS Codespaces in the documentation for aka.ms/spfx-webparts?

If you add the .MD file in https://github.com/pnp/sp-dev-fx-webparts/tree/Docs/docs/gettingstarted, I can make sure it shows up in the documentation. Just make sure to target the Docs branch.

[msftbot[bot]]

This issue has been automatically marked as stale because it has marked as requiring author feedback but has not had any activity for 7 days. It will be closed if no further activity occurs within next 7 days of this comment. Thank you for your contributions to SharePoint Developer activities.

[pschaeflein]

Well, the steps are already documented in the referenced blog post. I feel the benefit would be to have the repo already configured with the .devcontainer folder.

[hugoabernier]

@pschaeflein do you want to set one up as a sample and do a pull request? I'm not having much luck setting up codespaces on my side.

[pschaeflein]

Will do. Just documenting the steps to trust the dev certificate and will include that in the PR.

[andrewconnell]

IMHO...

I would only add this as docs... not implementing on the samples individually or on the project as a whole.

Samples are used for references... stuff like this can confuse what is required for samples vs. what's "extra for a sample setup".

Also... what about the debate "why would I use VS Codespaces vs. GitHub Codespaces?"

My $0.02: don't add this to the repo... add docs at most.

[hugoabernier]

Closing this issue as codespaces will be retired. Let's revisit when fully transitioned to GitHub codespaces.

[andrewconnell]

Codespaces is already going to be retired after being announced just a few months ago?!?!?!

[pschaeflein]

"Retiring" is click-bait used at the referenced site.

If you read the official blog post (https://devblogs.microsoft.com/visualstudio/visual-studio-codespaces-is-consolidating-into-github-codespaces/), you will see that Codespaces are alive and well, and will be hosted under the GitHub service only.

The VSCode extension, (and the future Visual Studio extension) will work the same. And I would argue that a button on the GH Repo to create/launch a codespace is much simplier than filling out a form (as was done on the online.visualstudio.com site).

The only difference is the billing. Instead of Azure subscription, it will likely be slotted into GitHub tiers.