Skip to content

Latest commit

 

History

History
161 lines (93 loc) · 4.91 KB

evaluation_template.md

File metadata and controls

161 lines (93 loc) · 4.91 KB
Raw

Project Name:

Evaluating Person or Team:

License

  1. What is the project's license? In most repositories there will be a file named LICENSE or something similar in the root level of the repository. This is the one to examine. There may be different licenses on specific files, but the project will have a main license.

Code Base

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

  2. What is the development environment? For example, is it Gnu C++ on Linux? Are there instructions for how to download, build, and install?

  3. Does the project depend on external additional software modules such as database, graphics, web development, or other libraries?

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

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

  6. What is the development environment? For example, is it Gnu C++ on Linux? Are there instructions for how to download, build, and install?

  7. Does the project depend on external additional software modules such as database, graphics, web development, or other libraries?

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

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

  10. Does the repository have tests?

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? Take the five most recently closed issues and look at when each was first reported. Compute the number of days that each was open and take the average.

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

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

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

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

  9. When was the most recent commit?

  10. How many issues are currently open?

  11. How long do issues stay open? Take the five most recently closed issues and look at when each was first reported. Compute the number of days that each was open and take the average.

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

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

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

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

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

  17. How many open pull requests are there?

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

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

  20. How many open pull requests are there?

  21. Do pull requests remain un-answered for a long time? Look at the closed pull requests to see how long they stayed open. Take the five most recently closed ones and look at when each was first reported. Compute the number of days that each was open and take the average.

  22. Is there active discussion on the pull requests? Use the same method as you did for the issues.

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

Compute the number of days that each was open and take the average.

  1. Is there active discussion on the pull requests? Use the same method as you did for the issues.

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

  3. 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 violte 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? Look through it and see if it is clear and thorough.

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

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

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

  8. Do maintainers thank people for their contributions?

Summary

Do you think this is a project to which it would be possible to contribute in the course of a semester?