OSD 600 (Open Source Development) is a class that is going to demand a lot of attention from me. I can tell already.
This week we took the experience and training of the students and leveraged them to help us all write better code. We each tested another student's work and helped them improve it. I looked at Joseph's project (https://github.com/joey2031/OSD600-Release0.1)and gave him some feedback.
It was pretty easy to find him! there are so many people in class that we all can kind of just ask for help, post our repositories, and someone will come along and give us a hand. It's extremely welcoming.
I raised a few issues with his project, though small.
The first was with his readme. (https://github.com/joey2031/OSD600-Release0.1/issues/2) It's important to have an easily readable readme! Joseph's readme, in my opinion, didn't properly inform the user on how to start his app. I just suggested a clearer paragraph. Easy!
The second was an issue with his argument checker. (https://github.com/joey2031/OSD600-Release0.1/issues/3) When the user inputted "-v" or "--version", the app would break! The user would have to write "v" or "version" instead. I just suggested he change the latter option to the former. Again, a small change that means a lot.
Finally, I noticed that his repo had his node_modules folder included. (https://github.com/joey2031/OSD600-Release0.1/issues/4) So I simply suggested he remove the folder and add a .gitignore so that it doesn't get uploaded again.
There were 4 issues on my repo as of writing that I'll list in point form:
- Readme is slightly unclear https://github.com/fluentinstroll/Link-Checker/issues/1
Easy fix! Be more clear and add a little more info about how ot run the app.
- Folder structure is unclear https://github.com/fluentinstroll/Link-Checker/issues/2
Again, simple to resolve, just rename some folders and move some files.
- Remove node_modules https://github.com/fluentinstroll/Link-Checker/issues/3
I just deleted node_modules folder and went on my way! Though I wonder if it's better to keep or not since the issue mentioned the arguments for and against.
- Add additional reasoning for why I included the libraries I did https://github.com/fluentinstroll/Link-Checker/issues/4
All together, the fixes were simple! And I learned a lot about working with git and other programmers.
This experience was plenty of fun! Also, I was surprised at how easy it was to find someone in our group to pair up with.
I can't wait to dive in to more involved projects with my classmates and the greater world of open source.
Top comments (0)