home ::
syllabus ::
timetable ::
groups ::
moodle ::
video ::
© 2021
This project has the same structure as Project1. That is, you are trying to write code that some other group will agree to extend in Project3.
Important Notes:
- Copy the following rubric to a markdown file. Fill it in. Where needed, add links into your repo to justify your answers. And that document to your repo as docs/proj2rubric.md.
- The following table has two new rows (see last two)
- We are need to see a significant improvement in Project2, compared to Project2. So some of these rows score much more than the others.
- As to the other rows, they are sorted in a particular way. In Project1, only the high scoring teams succeeded on the later items. So, if you want to get good mark in project2, pay extra attention to the latter rows.
| Score | Notes | Evidence |
|---|---|---|
| .5 | short release cycles | |
| .5 | workload is spread over the whole team (so one team member is often Xtimes more productive than the others... | |
| .5 | Docs: why: docs tell a story, motivate the whole thing, deliver a punchline that makes you want to rush out and use the thing | |
| .5 | the files CONTRIBUTING.md lists coding standards and lots of tips on how to extend the system without screwing things up | |
| .5 | Docs: doco generated , format not ugly | in GH |
| .5 | evidence that the whole team is using the same tools (e.g. config files in the repo, updated by lots of different people) | |
| .5 | evidence that the members of the team are working across multiple places in the code base | |
| 1 | Docs: what: point descriptions of each class/function (in isolation) | |
| .5 | Number of commits: by different people | in GH |
| 1 | issues are being closed | evidence in GH |
| .5 | issues are discussed before they are closed | even if you discuss in slack, need a sumamry statement here |
| .5 | Use of syntax checkers. | config files iin GH showing this checker's config |
| 1 | Issues reports: there are many | |
| .5 | Use of code formatters. | config files in GH showing your this formatter's config |
| .5 | Use of style checkers | config files in GH showing your config |
| .5 | Docs: short video, animated, hosted on your repo. That convinces people why they want to work on your code. | |
| .5 | test cases exist | dozens of tests and those test cases are more than 30% of the code base |
| .5 | Use of code coverage | config files in GH |
| .5 | other automated analysis tools | config files in GH |
| .5 | test cases:.a large proportion of the issues related to handling failing cases. | if a test case fails, open an issue and fix it |
| .5 | test cases are routinely executed | e.g. travis-com.com or github actions or something |
| 1 | Documentation describing how this version improves on the older version | |
| 3 | This version is a little(1), some(2), much(3) improved on the last version. | Tutor's assessment. |
| 16 | Total |
Please contact the group whose work you are extending. Ask from their grading rubric and its scores. If that grading show any problem areas, you need to fix them (otherwise you will lose marks this time around).