Skip to content

Latest commit

 

History

History
198 lines (101 loc) · 6.77 KB

visual_studio_code_evaluation.md

File metadata and controls

198 lines (101 loc) · 6.77 KB
Raw

Project Name: Visual Studio Code

Evaluating Person or Team: Eric Wu (Bowen-Wu)

Project Data

  1. Project description:
    Visual Studio Code is a lightweight but powerful source code editor which runs on your desktop.

  2. Project website/homepage: https://code.visualstudio.com/

  3. Project repository: https://github.com/Microsoft/vscode

License

  1. What is the project's license?
    MIT License

Code Base

  1. What is the primary programming language in the project? TypeScript

  2. What is the development environment?
    It is available for Windows, macOS and Linux. It comes with built-in support for JavaScript, TypeScript and Node.js and has a rich ecosystem of extensions for other languages (such as C++, C#, Java, Python, PHP, Go) and runtimes (such as .NET and Unity).

  3. Are there instructions for how to download, build, and install? How easy is it to find them? Do they seem easy (relatively speaking) to follow?

    Installation of Visual Studio Code is given on the main page of the project. It is relatively easy to find installation under the setup tab. There are step-by-step installation process, so it is easy to follow.

  4. Does the project depend on external additional software modules such as database, graphics, web development, or other libraries? If so, are there clear instructions on how to install those?

    Window Requirements: .NET Framework 4.5.2 is required for VS Code. Linux Requirements: GLIBCXX version 3.4.15 or later, GLIBC version 2.15 or later

  5. Is the code easy to understand? Browse some source code files and make a judgment based on your random sample.

    The code is not easy to understand, not because its hard to understand, but because its so massive. There's so many components that reading the documentation is necessary to understand the linkage between different components.

  6. Is this a big project? If you can, find out about how many lines of code are in it, perhaps on OpenHub.

    639K lines of code. It is big.

  7. Does the repository have tests? If so, are the code contributors expected to write tests for newly added code?

    The repository does have tests, it is recommended for newly added code. "Pull requests should contain tests whenever possible" according to their repository.

Code and Design Documentation

  1. Is there clear documentation in the code itself?

    For the most part, there is in-depth documentation throughout the code. There are some portions that are more densely documented than others.

  2. Is there documentation about the design?

    I did not find documentation on design. From what it seems, there wasn't much on how the components are structured.

Activity Level

  1. How many commits have been made in the past week?

    247 commits within the past week.

  2. When was the most recent commit?

    Most recent commit: 1 hour ago @ 2020-03-03T01:06:02.88Z

  3. How many issues are currently open?

    4591 issues currently open

  4. How long do issues stay open?
    The amount of time issues remain open is very different. Of the five that I sampled, all were opened and closed on the same day, average being around 8 hours.

  5. Read the conversations from some open and some closed issues. Is there active discussion on the issues?

    There's a few comments for each issue stating the resolution and comments about the issue. I'd say it is relatively active discussion.

  6. Are issues tagged as easy, hard, for beginners, etc.?

    Issues are not tagged based on difficulty.

  7. How many issues were closed in the past six months?

    10,125 issues were closed in the past six months.

  8. Is there information about how many people are maintaining the project?

    3,101 contributors on Github.

  9. How many contributors has the project had in the past six months?

    44 contributors in the past six months.

  10. How many open pull requests are there?

    154 open pull requests.

  11. Do pull requests remain un-answered for a long time?

    Of the closed pull requests, most of them are un-answered for a very short period, typically ~ 1 day.

  12. Read the conversations from some open and some closed pull requests. Is there active discussion on the pull requests?

    The moderators typically comment about the pull requests and there is active discussion.

  13. How many pull requests were opened within the past six months?

    890 pull requests were opened within the past six months.

  14. When was the last pull request merged?

    As I am writing this, last pull request merged 6 hours ago.

Welcomeness and Community

  1. Is there a CONTRIBUTING document? If so, how easy to read and understand is it? Look through it and see if it is clear and thorough.

    There is a CONTRIBUTING document under the documentation. It is very easy to read and understand. It is very clear and offers a thorough walkthrough of how to contribute.

  2. Is there a CODE OF CONDUCT document? Does it have consequences for acts that violate it?

    The project has adopted the Microsoft Open Source Code of Conduct. Consequences are not noted.

  3. Do the maintainers respond helpfully to questions in issues? Are responses generally constructive? Read the issue conversations.

    The responses are generally constructive. While it can be interpreted negatively, the moderators and other contributors like to offer questions to help justify any of the contributions someone wants to make.

  4. Are people friendly in the issues, discussion forum, and chat?

    People seem to be friendly, however from the looks of it, it doesn't look like most of the discussion are situated for newcomers. It seems much of the discussion are to those who are already involved in the project.

  5. Do maintainers thank people for their contributions?

    Yes.

Development Environment Installation

Install the development environment for the project on your system.

Describe the process that you needed to follow:

  1. how involved was the process?

    I followed the steps and Yarn did it all.

  2. how long it take you?

    About 5 minutes.

  3. did you need to install additional packages or libraries?

    I did, but Yarn did it for me.

  4. were you able to build the code following the instructions?

    Yes

  5. did you need to look for additional help in installing the environment?

    No

  6. any other comments?

    No

Summary

  1. Do you think this is a project to which it would be possible to contribute in the course of a few weeks before the end of this semester?
    I think if I understood the project a bit better, like looked through it longer it would be easier to contribute. As of now, I'm lost in how and where I can contribute.

  2. Would you be interested in contributing to this particular project?

    Probably.