Oz's notes for VIP students - conjure-cp/conjure-oxide GitHub Wiki

In no particular order:

  • Commit early, commit often is a common saying. Extend that to: create your PR early, push early, ask for feedback early. No need to wait until everything is "perfect" before sharing with everyone.
  • Use Github's draft / ready for review features on a PR to communicate intent.
  • Consider asking for code reviews from your peers (and conversely be ready to provide code reviews to your peers) before you ask Oz to review a PR.
  • Towards the end of a semester, everyone tends to submit many PRs. Inevitably, some will be merged before others, and those who are not merged early will have to deal with merge conflicts. I aim to review code as soon as possible once I am asked for a review and merge the oldest PR that is ready to be merged. First come, first served. Though this is not a perfect system, of course. Especially if you are struglling, dealing with merge conflicts might feel frustrating. Ask for help.
  • Which brings me to: in general be liberal in asking for help. Err on the side of communicating too much as opposed to too little. Do not suffer in silence, this is a group project for a reason.
  • I always say this and hopefully students agree: there is a lot of support available! I try to be very generous with my time, you have your peers, and we have the rest of the CP research group to lean on as well. But: the request needs to come from you. Pull the support out of us, make us work.

Work in progress, more to come...