jameskoh98
commented
5 years ago `Evaluation
| Topic | Excellent | Satisfactory | Needs Work |
|---|---|---|---|
| Coding style | x | ||
| Coding strategy | x | ||
| Presentation | x | ||
| Achievement, creativity | x | ||
| Ease of access | x |
Remarks:
- Really detailed, easy to read
name: PR template for CFSS about: Used for students submitting a pull request for a homework assignment title: Description of my submission labels: '' assignees: ''
Before submitting your pull request, have you:
README.mdfile describing the purpose of your repository, required packages, location of relevant files, etc.?Be sure to include your name somewhere in the title or description of your pull request, as well as reflect on what was hard/easy, problems you solved, helpful tutorials you read, etc.
Description of Steps
To get the changes into README.md, I first saved my changes locally in R Studio. After saving, I staged my edits by clicking on the “Stage” box in the Git tab, committed my changes to Git, essentially creating a snapshot of that version of my file, added comments describing the changes I made, and pushed the changes to GitHub. I was able to check that these changes were synced to GitHub, as well as rendered, by going back to my hw01 repository and clicking on the README.md file there. If the changes made locally were saved correctly, they were reflected in GitHub. Every time I made any significant edit, or wanted to see what my rendered document would look like, I would repeat these steps!
Reflection
For the most part, the workflow wasn’t too bad. Once I read up on the purpose and function of each step of the workflow process, as well as tried them out for myself, it became easier and easier to understand why I was doing what I was doing, and how it works.
I’d say the most difficult part of the process was taking the leap! I was very afraid that I would do something wrong and somehow mess up my README.md file, but once I actually committed and pushed my file, it became clear to me how these functions worked.
I also struggle a lot with embedding my image. I initially try embedding use a file path (drawing an image directly from my computer) but was unsuccessful in using this approach. After going back to the homework assignment description, I realized that I could upload the image to my repo and insert that URL into my README.md. I also used Google and Stack Overflow. As far as I know, there is no function to resize the image in a .md file, so I was not able to make it smaller in the final README.md file.
Additionally, I struggled with inserting a caption with my image and was unfortunately unsuccessful in incorporating this into my bio in GitHub. However, this worked in HTML, meaning there is likely an issue with how I typed it in R Studio
Everything else wasn’t too hard to figure out! The “Markdown Quick Reference” was really helpful guiding me through the process!