Skip to content

An IDE in the sky #1

@lakruzz

Description

@lakruzz

Congratulations

You successfully setup your copy from the template - and you are ready to work the issues. A a few things has already happened automatically in the background. Let's take a deeper look

Ultra shot on semantics in these issues: Each issue starts by listing the overall agenda as a table of content. The outcomes or learning goals of this issue. When you see:

  • 👉 A task in Pointed text in bold like this 👈

It means that you should do what the task implies and mark it as done. When you've checked all tasks you close the issue and head on to the next.

In this issue:

  • Browse the repo content in the GitHub web based editor (≈VS Code)
  • Turn on sync of settings on your user profile.
  • Introduce a tool to support an arbitrary new standard way-of-working
  • Add the extension that supports this new standard and make it a recommendation for other repo co-users
  • add, commit and push to git from the GitHub web based editor

Note:
Remember, these issues are yours. It's recommended that while you work the issues in this tutorial, you make it a habit to make notes-to-self in the comments to the issues. Leave a learning trail to your own future self. Or engage with others; come join the community discussions on this tutorial.


GitHub provides a lightweight version of VS Code for free for all GitHub users They call it the GitHub web based editor. It's hosted on github.dev as opposed to github.com

If you visit it directly github.dev you'll see an ultra short description on how to use this feature.

Either

  • 👉 Replace .com with .dev in your URL 👈 or
  • 👉 use the keyboard shortcut . 👈 ...while browsing a file.

The GitHub web based editor is actually a real VC Code IDE. You can even turn on the sync settings

  • 👉 Turn on sync (everything) - sign in with your GitHub account and authorize 👈
Details... image image

Som extensions are not Web Editor compatible, they are designed to work in a CodeSpace. We'll go there next, but first, try to install an extension that is actually Web Editor Compatible:

  • 👉 Search for and install GitHub Issue Notebooks 👈
image

The plugin is a Jupyter-like Notebook that enables you to generate all kinds of reports-as-code which will be stored as files .github-issues in the repo and shared among all team-members - and version controlled! Nice!

  • 👉 Create a GitHub Issue Notebooks file in the root of the repo. Give it a spin, add add, commit and push it. 👈

Now that we've added a .github-issues file in our project. This is probably going to be included in our standard way of working. So let's add that particular extension as a recommendation to our teammates and repo co-users. Such recommendations are captured in a /.vscode/extensions.json file.

  • 👉 Add the GitHub Issue Notebooks extension to the Workspace Recomendations. 👈
  • 👉 add, commit and pushthe /.vscode/extensions.json file . 👈

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions