This page serves as a catch-all for resources/reference material that might be handy
while working through the project (content on git/gitlab/github, markdown, etc).
Sample documentation
Sample versions of most of the core documents (proposals, requirements, team charters, etc)
can be found here.
Gitlab/github details for team repos:
Details on use of your gitlab or github team repos is provided
on the course gitlab page.
When it comes to inviting me to your gitlab/github project: on gitlab.csci.viu.ca I'm @wesselsd (David Wessels), adding as a 'reporter' is fine
on github I'm DaveWesselsVIU
both use my David.Wessels at viu email address
Code standards
For full marks, all your submitted code and documentation must adhere to either the
CSCI 265 standards or an alternative set of standards
developed by your team and approved by the course instructor.
Obtaining and submitting the individual contribution assessments for the team project
Git recap for individual portions provided in contribution assessments.
Getting feedback on the project phases
I'll post feedback for each person individually, using a git repo
named feedback.
The server-side repos have already been created (forked), you'll just clone
your feedback repo once, then in the future go into it and run a git pull
to grab any updates I've posted for you.
Getting the repo the first time:
git clone csci:csci265/$USER/feedback then cd into the directory and have a look at file 'phase1'
Getting updates in the future:
cd into your feedback directory and run
git pull and have a look at any files/file updates it pulled.
CSCI 265 project documentation using markdown (.md)
This semester, all of the documentation files for the project (both individual and team documents)
will be submitted as markdown (.md) files. This is the only acceptable file format for
documentation in the projects - if anything else is submitted you'll be required to resubmit
using this format.
It's important we have an agreed file format for sharing content across the team and across the course,
and a text-based format like markdown is much more suitable for tracking with version control systems
(like git) than other formats (word, pdfs etc).
A discussion of basic and extended .md syntax can be found at these URLs:
-
markdownguide.org/basic-syntax -
markdownguide.org/extended-syntax
Merlin's guide on how to configure your browser to display .md files can be found at URL
-
csci.viu.ca/~wesselsd/technotes.html#markdown