Assignment Dissemination and Submission - TheIronYard--Orlando/2015--SUMMER--ROR GitHub Wiki
Assignments
Each assignment will be delivered as a directory in this repo (not the wiki) that contains a README.md
file; for example, the pre-class assignment: 00 -- Here It Comes. The README
file will contain all the instructions for the assignment, a list of the minimal requirements, and a list of deliverables. If your work doesn't match the requirements or expected deliverables, it will be rejected. Over time, the assignments will provide fewer and fewer explicit instructions, as you are expected to become familiar with the process. Similarly, the requirements and deliverables will be enforced more strictly.
These are the bare minimal instructions you should follow for every assignment. Additional instructions or direction may be provided in an assignment's README
, but always ensure that you follow these steps:
- Create a Work In Progress (WIP) Issue in the class repository for every assignment
- Name it according to the assignment name with your name appended, e.g.
00 -- Here It Comes -- Brian Gates
- If a task list (i.e. check boxes) are provided for you in the assignment file, include them as the description of your WIP Issue
- If not (as in later assignments), create your own; you will be expected to break down larger tasks into smaller ones
- Estimate the complexity, difficulty, and risk of each major piece of the assignment with T-shirt sizes: Small (S), Medium (M), Large (L), Extra Large (XL)
- Name it according to the assignment name with your name appended, e.g.
- 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 in your
TIY-Assignments
repository for the assignment- Name the branch per the instructions in the assignment; each assignment will list a WIP Branch
- 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) from your WIP Branch to
master
in yourTIY-Assignments
repo- 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!
Note that some assignments won't involve writing code into your TIY-Assignments
repo, but you should still always create a WIP Branch in whatever repo you're working in. 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.