Skip to content

Latest commit

 

History

History
194 lines (131 loc) · 9.22 KB

astropy_evaluation_02.md

File metadata and controls

194 lines (131 loc) · 9.22 KB
Raw

Project Name:

Evaluating Person or Team:

Project Data

  1. Project description:

    Astropy is a set of software packages, which are written in Python, that are for the purposes of astronomy. This project is intend$

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

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

License

  1. What is the project's license?
    BSD 3-Clause "New" or "Revised" License

Code Base

  1. What is the primary programming language in the project? The primary language is Python. 95 percent is written in python and 5 percent is written in C.

  2. What is the development environment?

    According the the project website, if a use plans to work on this project regularly, they should do they development in a python virtual enviornment. Depending on the pythong distribution, you must use conda or virtualenvwrapper.

  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 instructions to install Astropy is very easy to find as it is located on the homepage. The installation instructions contains a link to Anaconda Python Distribution. This website leads to the anaconda website where you can download python and astropy. Then instructions go on to exaplain how to update the package. The instructions are fairly easy to follow and to find since its the first thing to be seen.

  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?
    Astopy has three strict requirements, which are Python 3.6 or later, Numpy 1.16.0 or later, and pytest 3.1 or later. Astropy can also depend of other packages for optional features.

  5. Is the code easy to understand? Browse some source code files and make a judgment based on your random sample.
    The code is easy to understand. I am familiar with python, so I am able to follow along. Also, the code snippets that I looked at seemed well written and are clean code. Also, the source code is well documented. THere ae a lot comments explaining what the code is doing.

  6. Is this a big project? If you can, find out about how many lines of code are in it, perhaps on OpenHub.
    This project comtains 151,734 lines of code, so this is a big project. According to Openhub, this project took an estimated 39 years of effort, starting in 2011 up until very recently.

  7. Does the repository have tests? If so, are the code contributors expected to write tests for newly added code?
    There is a file in the Github repository called pytest-astropy, where you can test you code. Code contributors are not required to write code.

Code and Design Documentation

  1. Is there clear documentation in the code itself?
    Yes, the source code is well documented and is clear.

  2. Is there documentation about the design?
    The website astropy.org contains a thorough documentation page about the desgin.

Activity Level

  1. How many commits have been made in the past week?
    From February 25 to March 3rd, there have been 32 commits to all branches.

  2. When was the most recent commit?
    The most recent commit was today, 12 hours ago.

  3. How many issues are currently open?
    There are 955 open issues currently.

  4. How long do issues stay open?

    After looking at five closed issues, the issues stay open for a day or two on average. However, there are people activly commenting and woking on the issue.

  5. Read the conversations from some open and some closed issues. Is there active discussion on the issues?
    There is an active discussion on the issue. I saw multiple people commenting on the issue discussing ways thee are fixing it.

  6. Are issues tagged as easy, hard, for beginners, etc.?
    The issues are not labled based on the difficulty level. There are tagged with the type of issue it is and what it involves. There are some that have "good first issue" written on it.

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

  8. Is there information about how many people are maintaining the project?
    Github shows that there are 324 contributors to this project.

  9. How many contributors has the project had in the past six months?
    There were 41 contributors in the last six months/

  10. How many open pull requests are there?
    There are 60 open pull requests.

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

    After looking at several closed pull requests, I saw that they were answered within a day on average.

  12. Read the conversations from some open and some closed pull requests. Is there active discussion on the pull requests?
    The response time for comments made to the pull request is quick. There is no active discusion on the pull request.

  13. How many pull requests were opened within the past six months?
    There were 454 pull requests open in the last six months.

  14. When was the last pull request merged?
    The last pull request merge was two days ago.

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 a contributing document that is very detailed and straight forward. The document states how to report issues, and step by step on how to contribute code. It also contains another section with tips, and a check list when submitting code.

  2. Is there a CODE OF CONDUCT document? Does it have consequences for acts that violate it?
    There is a code of conducts document. The github document just contains a link to the project website page that details thoroughly the code of conduct. There are no consqeunces listed on the webpage. THe code of conduct is more like a pledge.

  3. Do the maintainers respond helpfully to questions in issues? Are responses generally constructive? Read the issue conversations.
    The maintainers seem to respond quick to issues. The maintainers and contributors have a discussion ask ask questions. They seem helpfull and responsive. Also, theres an opn slack where contributors can ask questions and get more inquiry.

  4. Are people friendly in the issues, discussion forum, and chat?
    Contributors and other people on the project generaly seem friendly and open to discuss and chat.

  5. Do maintainers thank people for their contributions?
    Yes they do 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?
    It was not too involved. I downloaded the Anaconda package and followed the steps listed on the homepage.

  2. how long it take you?
    It took me about 10 minutes.

  3. did you need to install additional packages or libraries?
    There were other packages that were needed, but were automatically installed.

  4. were you able to build the code following the instructions?
    After some time, yes.

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

  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?

    I think i could possibly contribute to this project. It doesnt seem like it requires specilized knowledge. Also, I know python but would need to brudh up on my skills.

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

    Possibly, yes. It seems like an interesting project.