Skip to content

Latest commit

 

History

History
147 lines (73 loc) · 6.72 KB

gatsby_evaluation.md

File metadata and controls

147 lines (73 loc) · 6.72 KB

Project Name: Gatsby.js

Evaluating Person or Team: Muying Li

Project Data

  • Project description:

    Gatsby is a free and open source JavaScript framework based on React to build blazing fast websites and apps. Gatsby is a Progressive Web App that only loads critical data, in which most latest web technologies such as React.js, Webpack, JavaScript, CSS and moren APIs, and rich data plugin system are integral, it enables web app developers to build really fast website.

  • Project website/homepage: gatsbyjs.org

  • Project repository: gatsby

License

  • What is the project's license?
    MIT

Code Base

  • What is the primary programming language in the project?
    JavaScript (93.9%)

  • What is the development environment?
    Node.js and Git

  • 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. It is super easy to find andf follow since Gatsby's second tab is the Tutorials which help the users set up the environment step-by-step. The tutorial is very well-organized also.

  • 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?

    No. Gatsby sets up everything for the users already.

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

    Yes. I viewed several files and they are all documented detaily. Especially in files in examples folder, the number of total lines of documentation seems even more than the one of the actual code. Nonetheless, some files are code-only, which means they are lack of any documentation. But again, the code itself is still clear and easy for understanding.

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

    I think so. On OpenHub, it says Gatsby has 172K lines of code.

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

    Yes and yes. In e2e-tests's README.md, it says the tests are automatically run whenever the packages/ or e2e-tests/ directory is changed in a commit.

Code and Design Documentation

  • Is there clear documentation in the code itself?
    Yes.
  • Is there documentation about the design?
    Yes. There are layout related files, for example, click me.

Activity Level

  • How many commits have been made in the past week?
    More than 2 pages of commits (about 100 times).

  • When was the most recent commit?

    Today, March 3rd, about 8:00PM.

  • How many issues are currently open?
    594.

  • How long do issues stay open?
    Usually in a day, some were less than 15 hours and some took 2 days.

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

  • Are issues tagged as easy, hard, for beginners, etc.?
    Easy with descriptions.

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

  • Is there information about how many people are maintaining the project?
    I didn't find it.

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

  • How many open pull requests are there?
    128.

  • Do pull requests remain un-answered for a long time?
    No. Pull requests usually will be closed within a day.

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

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

    100 open, 1422 closed.

  • When was the last pull request merged?

    Today, March 3rd, 5:00PM.

Welcomeness and Community

  • 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. There are so many ways to contribute and each of them are easy to follow with documentation.

  • Is there a CODE OF CONDUCT document? Does it have consequences for acts that violate it?
    Yes. Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project’s leadership.

    When faced with repeated bad faith comments or harassment after an earnest attempt to mediate an issue, the Gatsby team reserves the right to remove someone from the GitHub repository and/or block them on social media. This decision will always be made with consensus from more than one team member. (Reference)

  • Do the maintainers respond helpfully to questions in issues? Are responses generally constructive? Read the issue conversations.
    Yes. I checked multiple closed issues, and most of them are ended with a big thanks.

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

  • 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:

  • how involved was the process?
    I could not install it successfully since it says there is a permission problem. But I upgraded my git...

  • how long it take you?
    It took me a while since I have to update my git version. But installing Gatsby CLI did not take a long time.

  • did you need to install additional packages or libraries?
    No.

  • were you able to build the code following the instructions?
    No.

  • did you need to look for additional help in installing the environment?
    Yes (for updating git).

  • any other comments?
    I could not directly download the latest verision of git and there is always a permission error while I was installing Gatsby CLI.

Summary

  • 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?
    From my installing exprience, I believe so. It might need to present how to deal with the errors that might appear during installing process, which we can contribute to it.

  • Would you be interested in contributing to this particular project?
    This project appeals to me since I'm very interested in web development and I took Applied Internet Technology last semester which provided me basics about Node.js. Also, it is a great opportunity for me to familiar myself with React.js which I barely know.