Skip to content

Latest commit

 

History

History
154 lines (90 loc) · 7.08 KB

OpenTelemetry_evaluation.md

File metadata and controls

154 lines (90 loc) · 7.08 KB

Project Name: OpenTelemetry

Evaluating Person or Team: Thomas / tk2487

Project Data

  1. Project description: Provides an observability framework (tracing, metrics, logging) to help analyze systems.

  1. Project website/homepage: https://opentelemetry.io/

  2. Project repository: https://github.com/open-telemetry/opentelemetry.io

License

  1. What is the project's license? Apache License 2.0

Code Base

  1. What is the primary programming language in the project? They are working on many different language versions at the same time but the JavaScript version is seeing the most progress with the Java version close behind.

  2. What is the development environment? If you have any of the listed languages they are working on installed (Go, JavaScript, Java, Python, PHP, Ruby, Erlang) you should be able to contribute.

  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? Whichever language version you decide to work on, the corresponding repository will have a contributing file that details how to get started and what programs you will need for that specific version.

  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. They have clear instructions and links to the download page.

  5. Is the code easy to understand? Browse some source code files and make a judgment based on your random sample. Yes. Each piece of code is commented that explains what it does.

  6. Is this a big project? If you can, find out about how many lines of code are in it, perhaps on OpenHub. Since there is no information on this project on OpenHub, I took a look at some of the contributions and it seems there are at least 20,000 lines of code for each language version.

  7. Does the repository have tests? If so, are the code contributors expected to write tests for newly added code? Yes. There are tests but contributors are not required to write them.

Code and Design Documentation

  1. Is there clear documentation in the code itself? Yes. Each piece of code is clearly explained.

  2. Is there documentation about the design? No. Not directly in the code but on their website.

Activity Level

  1. How many commits have been made in the past week? (*I will use the JavaScript version for the rest of the questions) There were 9 commits in the past week.

  2. When was the most recent commit? March 3, 2020.

  3. How many issues are currently open? 84.

  4. How long do issues stay open? 3.2 days on average.

  5. Read the conversations from some open and some closed issues. Is there active discussion on the issues? Yes. Most are just asking if they can take the issue but on some others there are actual extensive discussions on the issue.

  6. Are issues tagged as easy, hard, for beginners, etc.? No but they have size of the issue tags depending on the number of lines that are affected.

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

  8. Is there information about how many people are maintaining the project? 25 people on this version.

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

  10. How many open pull requests are there? 18.

  11. Do pull requests remain un-answered for a long time? No. They are usually answered in 1 day.

  12. Read the conversations from some open and some closed pull requests. Is there active discussion on the pull requests? Not much discussion, only approving of requests.

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

  14. When was the last pull request merged? March 3, 2020.

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. everything is clear and details step by step instructions.

  2. Is there a CODE OF CONDUCT document? Does it have consequences for acts that violate it? Yes. They follow the CNCF Code of Conduct.

  3. Do the maintainers respond helpfully to questions in issues? Are responses generally constructive? Read the issue conversations. Yes. They engage in constructive conversation to help resolve or probe for more information.

  4. Are people friendly in the issues, discussion forum, and chat? Yes. Everyone is civilized and friendly in their responses.

  5. Do maintainers thank people for their contributions? No.

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? Simple terminal commands for installations. Also needed to fork and set an upstream just like class exercises.

  2. how long it take you? Around 10 minutes.

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

  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. Everything was step by step.

  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? This project just isn't something I have the knowledge to use currently and without having a reason to use it, it will be hard to contribute to as well. So I don't think it's possible since I'm not familiar at all with the inner workings of this project.

  2. Would you be interested in contributing to this particular project? Not at the moment. As I said I don't find a reason to use it right now as it seems designed for professionals.