stub_template

[guygastineau]

I moved /_template/example.sh to the less ambiguous /_template/stub_template.

I rewrote it, and I removed what I considered to be bad advice (the set options).

Please let me know what you think everyone. The name is kind of redundant, so we could make it stub if you all want.

This is related #365, but it will not close it.

---

Reviewer Resources:

Track Policies

[guygastineau]

@kotp @glennj @IsaacG

[guygastineau]

It might be better for me to call it exercise_stub. I'll just wait for feedback from you all.

[kotp]

I agree it shouldn't be example, since it is actively the thing to be delivered... I think exercise_stub is preferred, it shows the intent via the file name.

[guygastineau]

Changed.

I'd like to make sure everyone has a chance to review the contents.

[kotp]

3 approvals before merge, please.

[glennj]

The stub comments would be a good place to link to the style guide and perhaps other docs sites

[IsaacG]

This sentence took me a few moments to parse. Maybe simplify it.

eg "Sometimes complex code can be made much more readable by breaking it up into functions."

[guygastineau]

I will work out a revision.

[guygastineau]

Is this better now?

[IsaacG]

Maybe move the general guidance into the bash template that shows up on the exercise description and make the stub a lot more ... stub-like? Short, sweet and simple without a repetitive wall of text that need to delete every exercise?

#!/usr/bin/env bash

main () {
  # your code here
}

main "$@"

[guygastineau]

We can work on that.

With our current testing set up I don't want the student to feel pressured into using functions. That is why I commented the whole thing.

[guygastineau]

If we move to a library testing model for our exercises, then all of these will change. Then our stubs will simply give the skeleton of the API that our lib needs, and these stubs will be irrelevant.

[guygastineau]

Unfortunately, we would still need to use a message telling students to delete the stub comments no matter how short the stub is.

In the example you give above at least 2 in 10 people will leave the # your code here line in their file.

[guygastineau]

I want to be clear, @IsaacG, that your suggestion here is ideal. Once #366 is resolved the stubs won't be throw away anymore.

I am mostly trying to satisfy #365 in the meantime.

[guygastineau]

I trimmed out some of the verbosity ;)

[guygastineau]

Does 24 lines make you feel better about this than 32?

[guygastineau]

@glennj I think that is a decent idea, but as Isaac points out we also don't want the stub to be crazy long.

There might be enough space for one link, but ultimately for anyone who knows what is going on this stub is just throw away.

I think that in the end the Readme file is the best place for these resource links to go. The README.md is also an actual md file, so links seem more appropriate there to me.

[guygastineau]

If I make all of the changes that I just commented, then this stub should be under 25 lines.
I think that is important, so that students can just select it all in one go and delete it even with default terminal height.

I'm not worried about us. I'm sure most of us would just j -> V -> G -> x 😈

[guygastineau]

I'll go ahead and put up the shorter version. If you all want this version we can just revert it.

[guygastineau]

@glennj @IsaacG let me know if you guys feel comfortable with this latest commit as a compromise.
It also wont be forever.

[kotp]

@glennj I think that is a decent idea, but as Isaac points out we also don't want the stub to be crazy long.

There might be enough space for one link, but ultimately for anyone who knows what is going on this stub is just throw away.

I think that in the end the Readme file is the best place for these resource links to go. The README.md is also an actual md file, so links seem more appropriate there to me.

No links in the stub file, but a reference to the README file, where there can be links instead. Yes! to "as concise and clear as possible" from me.

[guygastineau]

@kotp okay, so I will remove the link.

[guygastineau]

No links in the stub file, but a reference to the README file, where the can be links instead. Yes! to "as concise and clear as possible" from me.

I replaced the link with a reference to their local copy of the README.md. I used Bash as a proper noun again.

[IsaacG]

Looks good to me.

[glennj]

Looks good.