The following markdown document is a checklist of items you should complete before submission of your assignment. This exists to help you keep track of all the requirements you must fulfil.
- All members have read and signed the statement of originality. Failure to do so will result in zero marks.
- All external code, assets or help received outside the group is documented in the statement of originality.
- Link to GitLab repository provided to the course.
- Commits use your own account. Failing to do this may result in zero marks.
- Must have the relevant marking tutors added as 'maintainers'.
- At least 4 features classified as 'easy'.
- At least 2 features classified as 'medium'.
- At least 1 feature classified as 'hard'.
- A working standalone APK is included in the GitLab repo, i.e., an APK that can be loaded and execute correctly on an AVD.
- Have a markdown report document titled 'report.md' on your GitLab. We advise you to use the provided template when writing your report (it will help you cover everything necessary).
- The UID, name and roles (team structure) of all group members.
- A summary of individual contributions is well detailed by each member.
- A conflict resolution protocol is documented and well defined.
- A description of your application.
- Examples/use cases of your application.
- A UML diagram of your application (e.g. class diagram).
- A description of the application design (with a diagram if necessary).
- A description of design decisions made with regards to the data structures, tokenizers, parsers, design patterns and any other items you feel are relevant.
- A description of how your team addressed the surprise item and any decisions your team had to make in the process.
- All bugs and errors (that are known) are listed.
- Details of tests provided such as the type, number and coverage.
- Summary of all implemented features (categorised by overall feature and classified by their difficulty levels).
- Team Meeting Minutes (either linked from or inside the report itself). There must be at least 4 meetings among the team. See meeting template for guidance on how to structure these if you have never done this before.
Please note that Individual reflections must be submitted to Wattle in Week 11, at the same time as the rest of the work for this submission.
- All members have submitted their 100 to 120 word individual reflections related to their experience during the group project.
The following are some optional items that are conducive to your final marks. These are not necessary for your final submission but will assist in achieving a higher overall mark. Feel free to add additional items here for your own team to keep track of!
- Each team member understands how the whole application (including sections they may not have worked on) operate.
- The project files are well categorised and structured in different packages based on their functionalities.
- Make meaningful names of the variables and methods.
- Attempt modular design of your methods and classes. Follow the code reusability and single responsibility principles.
- The code is well commented.
- Variety of tests are used which cover the majority of the code.
- Good commit messages.