Skip to content

Latest commit

 

History

History
202 lines (116 loc) · 5.46 KB

Tuxemon_evaluation_1.md

File metadata and controls

202 lines (116 loc) · 5.46 KB
Raw

Project Name: Tuxemon

Evaluating Person or Team: Ryan @ryanhanli ---

Project Data

  1. Project description: Tuxemon is a completely free, open source turn-based monster fighting RPG.

  2. Project website/homepage: https://www.tuxemon.org/

  3. Project repository: https://github.com/Tuxemon/Tuxemon

License

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

Code Base

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

    Python (99.5%)

  2. What is the development environment?

    Pycharm and Python Virtualenv

  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?

    The README file has one and so does their main website. They seem very straightforward with not too many complicated steps.

  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?

    A few other open source Python libraries, but they're clearly shown in the instructions.

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

    Yes they seem to follow Python conventions and also include a Docstring to all of their functions.

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

    ~25,000 lines of code. Not as big as something like OpenFoodFacts, but it's a decently sized project.

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

    Yes, there are obselete tests. However, contributors aren't expected to write tests for newly added code.

Code and Design Documentation

  1. Is there clear documentation in the code itself?

    Yes

  2. Is there documentation about the design?

    Yes

Activity Level

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

    ~8

  2. When was the most recent commit?

    Mar 5 9:14pm EST

  3. How many issues are currently open?

    148

  4. How long do issues stay open?

    Depends on the issue, but around a week usually.

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

    Yes, there are a lot of comment bubbles.

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

    Yes, some of them.

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

    41

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

    Going off of the discord and contributors on Github, it seems there's only around 4 people maintaining the project.

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

    ~9

  10. How many open pull requests are there?

    7 open + 335 closed

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

    Some are open for weeks with conversation going back and forth while others are merged within a week.

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

    Yes. There are a lot of chat bubbles.

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

    5 Open + 62 Closed

  14. When was the last pull request merged?

    Mar 5 9pm EST

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. Easy to read.

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

    No.

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

    Yes.

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

    Yes.

  5. Do maintainers thank people for their contributions?

    Yes.

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?

    Process wasn't very involved. It was a typical Pip python installation process through terminal.

  2. How long it take you?

    Roughly 20 minutes.

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

    Yes.

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

    Yes. I just needed to install the external packages before I started.

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

    No.

  6. Any other comments?

    N/A

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?

    Yes. Adding a code of conduct or helping draw one up would be good. They also use have problems tagged as "easy" that I'm sure I can help with.

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

    Yes. It uses Python which is my most fluent language and also is very similar to a game I used to play when I was younger.