gitlearn

gitlearn copied to clipboard

Is there anything I can do to help the documentation along?

Also, are there any extra features you'd like me to add?

The documentation you had before was a decent reference, but we need a step-by-step tutorial. The students (and graders) don't need to know anything about implementation details, they just need to see an example of the steps they need to run.

Also, it wasn't obvious to me how to test programs like the ls program that take parameters from the command line instead of stdin.

I want to emphasize that I think your work was really good, and I'd really like to use the program. I just can't have students using it until there is simply no possibility of confusion.

I could make a video detailing the usage. would that be enough?

5-7 minutes, and you could show it in class next week! Doubt anyone has finished testing by now.

It would have to be text with screenshots. There's two problems with video: it's hard to use as a reference, and it's hard to modify when we find mistakes/make improvements.

How about a walk-through of examplestudent's rshell? The tutorial would have the reader clone examplestudent's rshell, make it, then open up the binary with tests/hw0 in runtests.

Then, the reader would step through the test cases in the file and fill in the grade based on the rubric. (all students will need to copy a standardized grade file to the root of their repo for this workflow)

Another way: clone the repo then copy in a grade file. This will eliminate the need for students to have a grade file in their repo.

Something like this sounds perfect!

On Sat, Apr 11, 2015 at 11:47 AM, M-Evans [email protected] wrote:

How about a walk-through of examplestudent's rshell? The tutorial would have the reader clone examplestudent's rshell, make it, then open up the binary with tests/hw0 in runtests.

Then, the reader would step through the test cases in the file and fill in the grade based on the rubric. (all students will need to copy a standardized grade file to the root of their repo for this workflow)

Another way: clone the repo then copy in a grade file. This will eliminate the need for students to have a grade file in their repo.

Reply to this email directly or view it on GitHub https://github.com/mikeizbicki/gitlearn/issues/21#issuecomment-91898636.

I'll work on this this weekend. I'll try to finish it by tomorrow. To do this, I'd need a rubric for hw0. I checked my ucr-cs100 fork from last quarter, and a rubric like the one I need wasn't used. Could you put one in the root of examplestudent's rshell?

1. I'll make a pull request to examplestudent's rshell with a barely finished rshell and a test folder including the tests for hw0.
2. I'll make a pull request to gitlearn and put the tutorial in docs/runtests-tutorial.md

oh, and I'll get a better screenshot of runtests in action. (multiple, for that matter)

If you look at the source of the markdown file for hw0, you'll see a rubric buried in the comments at the end.

I'd rather the source code for example student's rshell have basically nothing working. Something like it can call programs without parameters, and that's it.

On Sat, Apr 11, 2015 at 12:09 PM, M-Evans [email protected] wrote:

I'll work on this this weekend. I'll try to finish it by tomorrow. To do this, I'd need a rubric for hw0. I checked my ucr-cs100 fork from last quarter, and a rubric like the one I need wasn't used. Could you put one in the root of examplestudent's rshell?

1. I'll make a pull request to examplestudent's rshell with a barely finished rshell and a test folder including the tests for hw0.
2. I'll make a pull request to gitlearn and put the tutorial in docs/ runtests-tutorial.md

Reply to this email directly or view it on GitHub https://github.com/mikeizbicki/gitlearn/issues/21#issuecomment-91908002.

:scream: It was there the whole time!

And I'll do that. :smile:

There's a few hidden easter eggs like that for students who look throughout the whole repo :)

On Sat, Apr 11, 2015 at 12:46 PM, M-Evans [email protected] wrote:

[image: :scream:] It was there the whole time!

And I'll do that. [image: :smile:]

Reply to this email directly or view it on GitHub https://github.com/mikeizbicki/gitlearn/issues/21#issuecomment-91915645.