I am testing a browser-based workflow for students to "turn in" the homework they have posted on RPubs (or elsewhere).
I'm asking keeners / existing githubbers to try it first. I've done some testing in another repo with a cooperative friend, which yielded these draft instructions. Please help me refine them further before we inflict them on the whole class!
How to add a link to your published homework:
- Go to github and sign in.
- Go to the repository for this course: https://github.com/jennybc/STAT545A
- Go to the Markdown file (e.g. hm01_hw-submission-dryrun.md) you need to edit. Your browser will be pointed at something like
https://github.com/jennybc/STAT545A/blob/master/hm01_hw-submission-dryrun.md
. - Click "Edit" to put file into an editing environment.
- Make your edit. DO NOT GET CREATIVE OR SLOPPY. Follow the instructions. Look around at what everyone else is doing and make your entry follow the pattern, with only the minimal changes needed to customize for your homework.
- At the bottom of the page, fill in the description and click on "Propose file change" button. (Under the hood, this will fork the course repository and create a branch for your change, by default called "patch-1").
- A page will open that informs you whether there are any merge issues with the change. Here's where I am interested to see if all hell breaks loose when multiple people edit the same bulleted list.
- (Assuming the previous issue is survivable,) click on "Send pull request".
- Tidy up. This is where I have more uncertainty. A student should now have a fork of the course repo, with 2 branches (master and patch-1). Should we help them tidy up? Deleting the patch-1 branch seems very desirable. I think this blog post about tidying up after pull requests deals with what I, the repo owner, can do, not the student / repo forker? I wonder if leaving the student's fork and master branch is good for future edits, but I don't know of any way to make it actually track the course repo, so these steps might need to be repeated every time. Here are more links that look relevant: Fork A Repo and Syncing a fork. I note that the instructions about syncing a fork only show command line git, whereas I want all this happening in a broswer.
Please add your link in this bulleted list:
- Jenny Bryan: toyline
- Matthew Gingerich: TestFile
- Justin Chu: toylineTest