Skip to content

Latest commit

 

History

History
190 lines (98 loc) · 5.9 KB

Jupyter_nbviewer_evaluation.md

File metadata and controls

190 lines (98 loc) · 5.9 KB

Project Name: Jupyter

Evaluating Person or Team

[Fenglei Gu](https://github.com/FungluiKoo)

Project Data

  1. Project description:
    Project Jupyter exists to develop open-source software, open-standards, and services for interactive computing across dozens of programming languages. And it contains many sub-projects. In this file, I will exaborate on nbviewer, which is a simple way to share Jupyter Notebooks. NBViewer can render Jupyter Notebooks as static web pages.

  2. Project website/homepage: link

  3. Project repository: link

License

  1. What is the project's license?

    BSD-3-Clause

Code Base

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

    Python

  2. What is the development environment?

    conda, python3

  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?

    Yes. They are available on their website. Easy as long as the reader is familliar with command lines and the basic tools such as pip install.

  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?

    Yes, use pip install .

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

    Yes. They have good namings and comment blocks.

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

    Yes. 35,300 lines.

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

    Yes. To use it, you need to write a (python) unittest file containing code samples in the relevant language which test various parts of the messaging protocol.

Code and Design Documentation

  1. Is there clear documentation in the code itself?

    Yes, the namings are descriptive and they also have comment blocks

  2. Is there documentation about the design?

    Not observed.

Activity Level

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

    Depending on which repository. For example, nbviewer has 23 commits in last week.

  2. When was the most recent commit?

    Depending on which repository. For example, the most recent commit of nbviewer is on March 6th (today).

  3. How many issues are currently open?

    Depending on which repository. For nbviewer it is on 101.

  4. How long do issues stay open?

    For nbviewer it is on 15 days up to 3 years.

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

    There aren't much conversations for nbviewer.

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

    No.

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

    33 for nbviewer.

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

    37

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

    6 for nbviewer.

  10. How many open pull requests are there?

    3.

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

    No.

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

    Yes.

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

    31.

  14. When was the last pull request merged?

    Today (March 6).

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.

    Yes, it is clear and easy to read.

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

    Not observed.

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

    Yes.

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

    Generally friendly.

  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?

    Depending on whether some infrastructures are already installed on your computer.

  2. how long it take you?

    Not able to calculate as I have installed some components already. But the total time shouldn't be very long.

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

    Node.js

  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.

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?

    Yes, it would probably be the project to work on for me for the remaining of this semester, and hopefully I could form a team with others in this class who are also interested in Jupyter.

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

    Yes. I feel comfortable with Python and it would be great if we can form a team to together work on this project.