CSCI 265 Phase 2: team repo setup, standards and procedures, project requirements
Phase 2 is focused on establishing the standards and procedures your team will follow,
setting up the team's gitlab/github repo for the project, making and reporting on the team
progress on the remaining project deliverables (requirements, design, implementation, test plan).
There are four core deliverables for phase 2:
a short informal presentation outlining the team plan for the remainder of the project
in general and for phase 2 in particular (to be given during your team lab session on Oct. 3rd)
a team standards and procedures document (due Friday night October 17th)
a project update document (due Friday night October 17th)
setting up the team's github/gitlab project repository (also to be completed by Friday night October 17th)
giving a ~15-minute formal team presentation on your standards and procedures and the
current state of your project deliverables,
to be done in your team's lab section (October 17th)
*The individual contribution assessments are due the Monday evening October 20th.
Sample versions of most project documents can be found
here, based on a fictional team and project.
Setting up the team gitlab/github repo
The team needs to:
meet and agree upon whether they will use gitlab or github for their team repo,
have one person set up the team project repository on the chosen platform,
make sure everyone on the team has access to the repo and has logged in
to verify that
grant the instructor access to be able to view the repo contents,
set up the repo internal structure so that it matches what the team has
described in the version control section of their standards and procedures,
edit the repo readme to clearly describe the repo structure: in particular
where the relevant project documentation can be found (I would strongly prefer
that all documentation be kept together in a single clearly-named and easily-found directory)
Discussions on setting up gitlab/github repos can be found at URL csci.viu.ca/~wesselsd/courses/csci265/labs/gitlab.html
When inviting the instructor to your repo:
- on gitlab.csci.viu.ca I'm @wesselsd David Wessels
- on github I'm DaveWesselsVIU
both use my David.Wessels at viu email address.
The standards and procedures document
This document is to be named standards.md and kept in your team's documentation directory,
and is to follow the template shown in this skeleton version.
This document needs to clearly spell out:
the documentation standards and processes you'll be following, including
any templates or guidelines you'll be following (a url/link is fine if you're
following an existing industry standard),
any rules/tools to be used in spelling and grammar checking,
how you'll check/proofread each other's writing to ensure it follows the standards,
how you'll coordinate putting the parts together if different people are
writing different sections of a document (and ensure it can all be done
in time for the submission deadlines)
the coding standards and processes you'll be following, including
either your own written set of standards or links to existing industry standards,
any rules/tools to be used in formatting/checking code,
how you'll review each other's code to ensure standards are followed.
the version control standards and processes you'll be following, including
the overall structure of your project repository, including decomposition
into areas like development, staging/testing, and production/grading,
roles and responsibilities for the maintenance/handling of the repo,
rules regarding the processes to be followed when either pushing to the team repo
or sending pull requests to have a designated person update the repo,
rules around the handling of branches within the team repo,
rules or templates for git commits, pull requests, readme files, etc,
how you'll check/enforce that these standards and processes are followed.
The project update document
Much like the team presentations at the end of this phase, the document is meant
to give a clear summary of the progress made in the current phase and the current
state of all project deliverables.
The document should highlight:
The progress made in the current phase, and how that compared to the team's original
plan for the phase,
any changes to the assessed risks for the project,
any changes to the planned product features or functionality, or long term goals
for the project,
the current state of each deliverable (charter, standards, requirements, design,
test plan, repo/infrastructure, code base, art assets, etc).
End-goal deliverables
By the end of the project the team is also expected to have completed:
and, of course, the actual product code/assets and test resources.
Teams are permitted to craft their own life cycle plans and phase approaches for how/when
the different deliverables are completed, but I tend to recommend making at least some
progress on most deliverables in each phase - giving you the opportunity to get some of
the documentation work done and obtain some feedback in phases 2 and 3.
(The final mark for each of these deliverables will be based on the final state
of the deliverables, so you are encouraged to get feedback in early phases and then
refine the deliverables with each subsequent phase.)Assessment and marks
Be sure all team members have read the contributions assessment
page, and complete and submit their assessments by the evening of October 20th
(phase2.md in your individual contributions repos).