Documentation

Why?

Just like everyone wants to write great tech blogs but not many actually do it because of the tremendous amount of effort and dedication needed, the core challenge for the project feature to work is how we can make it super easy and effortless for our members to share the project they are working on, and provide continuous updates on learnings and accomplishments

Existing Solutions

Currently, there are many tools that allow users to log their work as they go. For example, HeySpace, CodeStream, Google Docs etc. Some developers here use plain old Pen and Paper. But there is one common issue in all of them. They take the developer's attention away from the coding environment, The Code Editor.

This extension will be our attempt to solve that issue while keeping the functionality of the work logs in the development environment.

Solution

This is a VS Code extension that will be distributed internally to Commit Developers. The reason VS Code was chosen as the target IDE is that according to StackOverflow more than 70% of the developers use VS Code as their primary IDE, which will cover the vast majority of the developers.

Current Design

TBD

Current Features

• Connect to Commit API
  • Ability to add updates to the projects
  • Ability to subscribe to events
• Connect with GitHub Account

Upcoming Features

• Ability to pull public GitHub repositories for authenticated user
• Ability to link a given repository to commit a project, which includes adding a repo URL to commit the Project
• Ability to get a list of Collaborators on a given public repository
• Ability to get code percentage

Resources

• Git API
• VS Code Extension API
• VS Code Webview API
• Commit GraphQL API
• VS Code Language Server Extension Guide
• GitHub OAuth App
• GitHub Rest API

Contributors

• Beier Cai
• Bill Monkman
• Daman Dhillon