...
DRY (Don’t Repeat Yourself);
KISS (Keep it Simple Stupid);
Using abstractions appropriately, including external libraries and modules; and
Adhering to language-specific conventions (e.g. “Pythonic”);
Correct casing of variable, function and class names;
Meaningful variable and function names;
Readability of code and use of whitespace; and
Modularisation and use of helper functions where needed.
...
2.2 Testing Practices
As part of implementing the service, you will need to use test-driven development.
...
System tests which test the API endpoints;
Unit tests which test individual parts of the system working in isolation; and
Your tests provide over 85% coverage of the code in the repository. You are welcome to change this requirement as you see fit, however it must be justified.
...
2.3 Deployment 🚀
Students have the freedom to select any deployment provider of their choice that suit their project needs and preferences. Students also need to share their API’s URL in 🚀 API Service Link Sharing Hub - SENG2021 25T1 - Confluence
Update your Software Architecture diagram as needed.
...
6. Submission ⬆️
Submission Requirements
Make the URL of your API publicly available (see 🚀 API Service Link Sharing Hub - SENG2021 25T1 - Confluence)
Add a link to your Git repository inside your online documentation website (Confluence page).
The Confluence page should be named "Codebase" and submitted via Moodle Sprint 2 submission.
Ensure that your tutor has full access to the repository and documentation space.
...