Skip to content

Latest commit

 

History

History
140 lines (113 loc) · 6.16 KB

Osu_evaluation.md

File metadata and controls

140 lines (113 loc) · 6.16 KB

Project Name: Osu

Evaluating Person or Team: Noah Brumfield

Project Data

  1. Project description:
    "Rhythm is just a click away!" Mouse and keyboard based rhythm game.

  2. Project website/homepage: https://osu.ppy.sh/home

  3. Project repository: https://github.com/ppy/osu

License

  1. What is the project's license?
    MIT (Which is surprising, because the game still has an "owner". Guess its because it's online, maintained by the owner)

Code Base

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

  2. What is the development environment?
    Different depending on the os being used and the version being worked on. For all, the .NET Core 3.1 SDK is required. For the mobile version, xamarin is required. On linux, A system wide FFmpeg installation is required for video decoding.

  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?
    Theres some light instructions. Not a lot on the environment, but there are build instructions for their recommended IDE's.

  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?
    No, nothing outsided the listed envorinment requirements.

  5. Is the code easy to understand? Browse some source code files and make a judgment based on your random sample.
    Somewhat? For context, this prject only went open source recently, and its somewhat easy to tell as some of the code seems like itd be very well written and easily understood if youre the one who wrote it. As the more integral parts call from smaller and smaller helper classes its hard to tell what each does. Its pretty interesting to see how they coded out some of the game mechanics, though.

  6. Is this a big project? If you can, find out about how many lines of code are in it, perhaps on OpenHub.
    Its quite big, plenty of contributors, lots of code, and a VERY strong user base that always wants new features

  7. Does the repository have tests? If so, are the code contributors expected to write tests for newly added code?
    There is a bank of existing types of tests for different scanarios. (Visual, Scoring, Gameplay) that can be used separately from the rest, I believe making it so that new contributors do not have to use their own test, jsut make sure it works with the current tests.

Code and Design Documentation

  1. Is there clear documentation in the code itself?
    A small amount. Seem more like "notes to self" from the creator than true documentation.
  2. Is there documentation about the design?
    No

Activity Level

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

  2. When was the most recent commit?
    10 AM march 6th, 8 hours before this writing.

  3. How many issues are currently open?
    821

  4. How long do issues stay open?
    Usually closed within the week

  5. Read the conversations from some open and some closed issues. Is there active discussion on the issues?
    There is. Sometimes its a bit short, or the creators shut it down quick as they already made a decision on that issue. Mostly short, and the creators have their ideas outlined already.

  6. Are issues tagged as easy, hard, for beginners, etc.?
    There are a few tagged by difficulty, but they seem like they were made from one attempt to do so and left there forever.

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

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

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

  10. How many open pull requests are there?
    81

  11. Do pull requests remain un-answered for a long time?
    Many larger feature implementations can take weeks back and forth, but most are just a few days

  12. Read the conversations from some open and some closed pull requests. Is there active discussion on the pull requests?
    Yes, similar to the issues, creators tell it how it is.

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

  14. When was the last pull request merged?
    1 day ago, march 5, 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.
    None
  2. Is there a CODE OF CONDUCT document? Does it have consequences for acts that violate it?
    No code
  3. Do the maintainers respond helpfully to questions in issues? Are responses generally constructive? Read the issue conversations.
    Again, the creators can be short with people in telling the the decisions theyve made.
  4. Are people friendly in the issues, discussion forum, and chat?
    Not necessarily friendly but not unfriendly either.
  5. Do maintainers thank people for their contributions?
    No, not usually

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?
    Super simple
  2. how long it take you?
    About A minute
  3. did you need to install additional packages or libraries?
    Just the .NET CORE SDK
  4. were you able to build the code following the instructions?
    Small problem here. In their envoronment section they had their recommended IDE's, which, being recommended I assumed were optional, but their build instructions have them specifically in mind.
  5. did you need to look for additional help in installing the environment?
    Not for .NET
  6. any other comments?
    A little sparse on details, not super newbie friendly

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?
    Unfortunately not. It seems VERY fast paced, stresses me out.

  2. Would you be interested in contributing to this particular project?
    I don't think i'm too interested in contributing, but I wouldn't mind just looking at the code. Seems like a good way to pick their brain on how they built the game from the ground up.