forked from cis-ds/course-site
-
Notifications
You must be signed in to change notification settings - Fork 0
/
hw01_edit-README.Rmd
56 lines (33 loc) · 2.91 KB
/
hw01_edit-README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
---
title: "Homework 01: Edit README.md"
output: html_document
---
# Overview
Due before class Wednesday October 5th.
The goal is to test your software installation, our GitHub setup, and our homework submission process via pull request.
# Fork the `hw01` repository
Go [here](https://github.com/uc-cfss/hw01) to fork the repo for homework 01.
# Edit `README.md`
When you create the repository, you will notice there is only one file in the repo: `README.md`. In future assignments, the repo will be seeded with additional files/data that are necessary to get started.
If you are already familiar with GitHub, edit the `README.md` any way you wish.
If you are new to Git and GitHub, click on the `README` link in the area that looks like a file browser. Click on the pencil and make an edit. Then head down to "Commit changes". Enter a short *commit message*. Then click "Commit changes". This is how you can edit files in GitHub repository through the browser. If you are still mystified by Git(Hub), you can use this browser-based method to edit `README.md` until you get more comfortable with using Git locally and pushing to GitHub. *However, if at all possible*, implement a more powerful workflow:
* Pull from GitHub (just an empty precaution now, but will matter when you collaborate with others)
* Make changes locally to `README.md` in RStudio
* Save your changes
* Commit your changes to your repo
* Push the commit to GitHub
*At the very least*, change `README.md` to something like "This is the repository of Benjamin Soltoff for homework 01," just to prove you have been there. Practice making a link, for example, to the [main course webpage](http://uc-cfss.github.io). The goal here is to demonstrate you have setup your software correctly.
# Report your process
Include a description of how you got the changes into `README.md` on GitHub when you submit your assignment via pull request.
* Did you edit in the browser at GitHub.com?
* Did you pull, edit locally, save, commit, push to GitHub.com?
You're encouraged to reflect on what was hard/easy, problems you solved, helpful tutorials you read, etc.
# Submit the assignment
Follow instructions on [homework workflow](hw00_homework_guidelines.html#homework_workflow).
# Rubric
Check minus: `README.md` says equivalent of "This is the repository of Benjamin Soltoff". All work done via browser at github.com ... but that's just a guess, because student doesn't actually say how it was done.
Check: something in between
Check plus: `README.md` provides a proper introduction of student to the class. It also demonstrates experimentation with 4 or more aspects of the Markdown syntax. Examples: section headers, links, bold, italic, bullet points, image embed, etc. The student describes how they got the changes into `README.md` and offers a few reflections on their GitHub workflow and their experience with Markdown.
### Acknowledgments {.toc-ignore}
```{r child='_ack_stat545.Rmd'}
```