Skip to content

Latest commit

 

History

History
154 lines (90 loc) · 4.59 KB

evaluation_template.md

File metadata and controls

154 lines (90 loc) · 4.59 KB

Project Name:

Evaluating Person or Team:

Project Data

  1. Project description:

  1. Project website/homepage:

  2. Project repository:

License

  1. What is the project's license?

Code Base

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

  2. What is the development environment?

  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?

  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?

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

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

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

Code and Design Documentation

  1. Is there clear documentation in the code itself?

  2. Is there documentation about the design?

Activity Level

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

  2. When was the most recent commit?

  3. How many issues are currently open?

  4. How long do issues stay open?

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

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

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

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

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

  10. How many open pull requests are there?

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

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

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

  14. When was the last pull request merged?

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.

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

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

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

  5. Do maintainers thank people for their contributions?

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?

  2. how long it take you?

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

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

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

  6. any other comments?

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?

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