Skip to content

Open Energy Dashboard Evaluation #85

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Open Energy Dashboard Evaluation #85

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5bc2b8d
Create OpenEnergyDashboard_evaluation.md
Moonsolol Apr 20, 2020
4641a02
Update OpenEnergyDashboard_evaluation.md
Moonsolol Apr 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
175 changes: 175 additions & 0 deletions OpenEnergyDashboard_evaluation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,175 @@
# Project Name: Open Energy Dashboard



**Evaluating Person or Team**: <br>
Terry Su (Moonsolol) <br>
Carsen Decker (carsendecker) <br>
Lucas Ortiz (lucasortizny) <br>
Barkin Simsek (woswos) <br>
Sijia Meng sm7515 <br>
Anthony Zeng (anthonyzeng99) <br>
David Wen (Flydx1234) nlw279 <br>
---

## Project Data

1. Project description: <br>
Displays energy and electricity usage and info from meters

1. Project website/homepage:
https://openenergydashboard.github.io/

1. Project repository:
https://github.com/OpenEnergyDashboard/OED

## License

1. What is the project's license? <br>
MPL-2.0



## Code Base


1. What is the primary programming language in the project?
Typescript, Javascript

1. What is the development environment? <br>
Docker

1. 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? <br>
Yes, there is a usage.md file with instructions. They are relatively easy to follow.

1. 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? <br>
Yes, the project has additional dependencies. Plotly and Postgres are the major ones.

1. Is the code easy to understand? Browse some source code files and make
a judgment based on your random sample. <br>
Sort of maybe complicated

1. Is this a big project? If you can, find out about how many lines of code
are in it, perhaps on [OpenHub](https://www.openhub.net/). <br>
47.7k lines of code

1. Does the repository have tests? If so, are the code contributors expected to write tests for newly added code? <br>
There are tests, no contributors are not expected to write tests


## Code and Design Documentation
1. Is there clear documentation in the code itself? <br>
There is some documentation, it depends on the file. Some files have none, some have pretty extensive documentation.

1. Is there documentation about the design? <br>
No

## Activity Level


1. How many commits have been made in the past week? <br>
Three Commits have been made in the past week.

1. When was the most recent commit? <br>
The most recent commit was April 14th.

1. How many issues are currently open? <br>
89 Issues are open.

1. How long do issues stay open? <br>
1-2 weeks

1. Read the conversations from some open and some closed issues. Is there active discussion on the issues? <br>
Not really, only 1-2 comments on most issues


1. Are issues tagged as easy, hard, for beginners, etc.? <br>
There's a tag for good_first_issue


1. How many issues were closed in the past six months? <br>
12 issues were closed in the past six months.


1. Is there information about how many people are maintaining the project? <br>
There are 21 contributors, 4 pretty active ones.


1. How many contributors has the project had in the past six months? <br>
3 contributers.

1. How many open pull requests are there? <br>
8 pull requests

1. Do pull requests remain un-answered for a long time? <br>
<!--
Look at the closed pull requests to see how long they stayed open.
Take the five closed pull requests (they can be most recently closed or a sample distributed over time) and look at when each was first created.
Compute the number of days that each was open and take the average.
-->
They stay open for an average of 14 days. Although there is a great amount of variation.

1. Read the conversations from some open and some closed pull requests. Is there active discussion on the pull requests? <br>
Most pull requests have only 1-4 comments, however a rare few have upwards of 50(!)

1. How many pull requests were opened within the past six months? <br>
24

1. When was the last pull request merged? <br>
7 days ago, Apr 13.


## 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. <br>
They have the document and they ask that you sign a document before contributing. But they don't provide detailed guidelines on contributing.

1. Is there a CODE OF CONDUCT document? Does it have consequences for acts that violate it? <br>
No, they don't have a CODE OF CONDUCT document.

1. Do the maintainers respond helpfully to questions in issues? Are responses generally constructive? Read the issue conversations. <br>
There are some issues with active dicussions, but many of the issues remain open without any comments.

1. Are people friendly in the issues, discussion forum, and chat? <br>
They're professional about it

1. Do maintainers thank people for their contributions? <br>
No. There is no "thank you."

## Development Environment Installation

Install the development environment for the project on your system.
Describe the process that you needed to follow:
First, developers need to have docker installed. Next, developers need configure the docker as mentioned [here](https://github.com/OpenEnergyDashboard/OED/blob/development/USAGE.md). Finally, developers need to clone the GitHub repository and run the commands listed [here](https://github.com/OpenEnergyDashboard/OED/blob/development/USAGE.md). However, instructions are not clear and ambiguous.

1. how involved was the process? <br>
We couldn't meaningfully install the development environment because it requires a meter with an ip address on the same network as the host in order to test it.

1. how long it take you? <br>
Cloning didn't take very long. Our install user already had docker, docker-compose, and npm installed.

1. did you need to install additional packages or libraries? <br>
No

1. were you able to build the code following the instructions? <br>
No, see above.

1. did you need to look for additional help in installing the environment? <br>
No

1. any other comments? <br>
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? <br>
Probably not, as it is very dependent on you owning actual hardware (an energy meter) to use at all, or to test any changes made to the code.


1. Would you be interested in contributing to this particular project? <br>
No, I don't have electricity, No, Not really, not necessarily, No