Feedback-on-reproducing-projects

[annaps96]

REPRODUCING CODE: WHAT DID YOU LEARN?

Go to the GitHub repository of the project you're reproducing -> Open an 'Issue' -> Copy all the text below the --- into that 'Issue' -> Start answering the questions there.

Hint: you can place an X within the square brackets to mark off a checkbox, like this: [X] Yes

---

1. What project did you reproduce (include the link)?

-> https://github.com/lilimelgar/testrepo

2. Does the project have the following on it's GitHub repository?

• README
• A license
• Citation information
• Requirements for running the code (dependencies)
• An understandable folder structure

3. What did you appreciate about the project's repository?

-> the README file: well-structured, guides you through each step

4. Do you have any suggestions for improvement to the repository?

-> would be great to have a setup.py file which contains all requirements. By running "pip install -e ." all requirements are installed in editable mode.

5. Did you manage to run the project successfully?

• Yes
• Largely
• No
• Other (please specify):

6. Where did you have to give up reproducing this repository (if applicable)?

-> by setting up various modules

7. Did you have to go into the code?

• Yes
• No
• I didn't have to, but I had time left/was intrigued, so I did it anyway!

8. If you looked at the code: what did you like?

-> Lots of comments, good readability

9. If you looked at the code, what would be a single line of advice you want to pass on to it's author?

-> To use docstrings (to start with in the code, before functions and classes)

10. Any final comments to the author?

-> Well done, need some fine adjustments

11. Do you think the class will benefit from a live demo of the reproduction of this project? Why/what can we learn?

-> Of any project would be great. Then you know which steps needs to be followed or what you have missed out.