How to Submit Homework Assignments - TheIronYard--Orlando/2015--FALL--ROR GitHub Wiki

How to Submit Homework Assignments

These are the minimal instructions you should follow for every assignment. Additional instructions or direction may be provided in the assignment file, but always ensure that you follow these steps:

• Create a Work In Progress (WIP) Issue in the class repository for each assignment
  • Name it by appending your name to the assignment name, e.g. 00 -- Brace Yourself -- Brian Gates
  • Copy and paste the task list (i.e. check boxes) provided in the assignment file as the description of your WIP Issue
  • Fill in more details! You will be expected to break down larger tasks into smaller ones; if you're daunted by a large task, break it down!
  • Estimate the complexity, required effort, and uncertainty of each major piece of the assignment with T-shirt sizes: Small (S), Medium (M), Large (L), Extra Large (XL)
    • Complexity is really only important as it relates to effort - a complex, high effort task should be split into subtasks
    • An example of a complex, low-effort task would be doing your taxes - lots of steps, but each one small enough that nothing would be gained making separate estimates for each
    • Uncertainty in a task means that you are unsure how much effort will be required
• Check off tasks as you finish to demonstrate progress; note the progress bar in the Issues list
• Create a new Work In Progress (WIP) Branch for the assignment in each repository that you'll be working
  • Name the branch per the instructions in the assignment!
  • Ensure that you commit all your work into your WIP Branch only
  • Push that branch to Github regularly to show progress; don't wait until you're "done" to push your work!
• Open a Pull Request (PR) to show your work:
  • Your from or HEAD branch should always be the WIP Branch; each assignment will specify a into or BASE branch for the PR.
  • Add a link to your WIP Issue in a comment on your Pull Request
  • Note that the PR will update automatically as you push more work to the branch
  • Do this step as soon as you have a commit; don't wait until the due date!

Some assignments will be long-running and will span several branches or Pull Requests (PRs). You may also be assigned groups or pairs for certain assignments. The assignment will dictate whether you both need code and branches in your own repos or if you're expected to share repositories for a project. You should always create a WIP Issue in the class repo, though, and link to your work.