Skip to content

Latest commit

 

History

History
162 lines (102 loc) · 6.43 KB

twine_evaluation.md

File metadata and controls

162 lines (102 loc) · 6.43 KB

Project Name: Twine

Evaluating Person or Team: Carsen (@carsendecker)

Project Data

  1. Project description:
    Twine is a tool for creating interactive, nonlinear narratives and games.

  2. Project website/homepage: https://twinery.org/

  3. Project repository: https://github.com/klembot/twinejs

License

  1. What is the project's license?
    GNU General Public License 3.0

Code Base

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

  2. What is the development environment?
    No special dev environment, just code in anything that can work with javascript, HTML, or CSS.

  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?
    There are some basic instructions on the repo's README file. They seem pretty easy to follow, as it isn't too complicated to install and build.

  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?
    It uses a couple things, mainly npm for installing and building the app. If you want to build to MacOS or Linux, you need Wine and Makensis.

  5. Is the code easy to understand? Browse some source code files and make a judgment based on your random sample.
    It seems nicely organized, and there are a smattering of inline comments around.

  6. Is this a big project? If you can, find out about how many lines of code are in it, perhaps on OpenHub.
    It's not a super big project, and thus I can't find it on OpenHub. RIP

  7. Does the repository have tests? If so, are the code contributors expected to write tests for newly added code?
    Yes! It also specifies in their contributing document that contributors should create Jest unit tests.

Code and Design Documentation

  1. Is there clear documentation in the code itself?
    Depends on the script, but there does seem to be some brief documentation in the code for certain methods and such.

  2. Is there documentation about the design?
    There is some documentation on the design in their wiki page, but it the site appears to be temporarily down right now.

Activity Level

  1. How many commits have been made in the past week?
    0 commits. Not lookin good for Twine

  2. When was the most recent commit?
    Feb. 1st

  3. How many issues are currently open?
    209 issues.

  4. How long do issues stay open?
    There was a more major issue that I looked at that was open for almost a month, one open for a week, and a few smaller ones that were closed within a day.

  5. Read the conversations from some open and some closed issues. Is there active discussion on the issues?
    There is some good discussion, and is almost always at least one comment, many times even more, on most of the closed issues.

  6. Are issues tagged as easy, hard, for beginners, etc.?
    They have a tag for a good first issue, but none of the open issues are actually using the tag.

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

  8. Is there information about how many people are maintaining the project?
    There seems to be one main contributor within the past year or so, with over 300 commits. The second most contributor in that time frame has 11. Yikes.

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

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

  11. Do pull requests remain un-answered for a long time?
    Some are answered within a day, some are answered within a few weeks.

  12. Read the conversations from some open and some closed pull requests. Is there active discussion on the pull requests?
    There is decent discussion on the pull requests, and it seems to be pretty civil.

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

  14. When was the last pull request merged?
    Last pull request was closed Feb 1st.

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.
    There is, although it is pretty brief.

  2. Is there a CODE OF CONDUCT document? Does it have consequences for acts that violate it?
    There is no code of conduct.

  3. Do the maintainers respond helpfully to questions in issues? Are responses generally constructive? Read the issue conversations.
    They seem to be pretty civil and constructive in responses. The conversations seem pretty informative.

  4. Are people friendly in the issues, discussion forum, and chat?
    Seem pretty friendly, and they do seem helpful and civil.

  5. Do maintainers thank people for their contributions?
    Occasionally, depends on the contribution I guess.

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?
    Not super involved, as most of it was just installing the source code and having a JS IDE.

  2. how long it take you?
    5-10 minutes.

  3. did you need to install additional packages or libraries?
    You need to make sure you have npm for building the app, as well as Wine and Makensis for OSX and Linux

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

  5. did you need to look for additional help in installing the environment?
    Not really, mainly just installing the external libraries and such were the biggest problem.

  6. any other comments?
    Nope

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?
    While I am interested and really like the app itself, I am unsure whether or not it would be a good project to work on as a group. It is not super active, but that also might mean that there is a decent amount of stuff to work on. What contributions do get made do seem to have some good discussion though.

  2. Would you be interested in contributing to this particular project?
    I would be interested in contributing mainly because it is written in mostly Javascript, HTML, and CSS, which I am familiar with, and that I enjoy using the program myself. Otherwise, it is still yet to be seen whether or not it is a good idea for a group to try and contribute, if it is active enough.