News
Deliverables in Week 11 & Week 12
Written on 14.01.2020 13:45 by Thomas Bock
Deliverables in Week 11:
- The progress report (incl. time log) has to be submitted to the CMS by the end of Friday (2020-01-17, 23:59). The progress report has to contain an additional section in which the work on your issues has to be documented. In this additional section, you should place the answer to the following questions:
- Who worked how long on which issues this week?
- Which new issues were created this week? / Which bugs were found this week?
- Which issues were resolved, which bugs fixed this week?
- Which tests are already written / generated? (regardless of whether they already pass or not)
Deliverables in Week 12 (final deliverable):
- The following deliverables have to be submitted to the CMS by the end of
Friday (2020-01-24, 23:59)Monday (2020-01-27, 23:59):- The progress report (incl. time log). The final progress report has to contain a link to your public GitHub repository (see below).
- The final test report (as PDF). The final test report should build on your test plan and contain the current results of your tests (passed or not; if they still do not pass, provide a reasonable explanation for that). Also state whether the tests discovered any errors or bugs. The final test report has to report the test quality in terms of code coverage. Also provide a short statement on the code coverage (e.g., explaining why the coverage might be noticably low or high for certain modules).
- Instructions on how to build, deploy, and use your software.
- Video of the software (90–180 seconds), showing core use cases and features.
- Optional: Final requirements documents, use-case diagrams, UML class and sequence diagrams can be uploaded to the CMS, but this is not necessary (i.e., the diagrams and documents can be updated if something has changed, but we don't request it).
- The final implementation has to be pushed to the master branch of your GitLab repository by the end of
Friday (2020-01-24, 23:59)Monday (2020-01-27, 23:59). The final software product has to contain the implementation of all must-have requirements. (Implementation of may-have requirements as time permits.) - In addition, to finally publish your work, you need to create a public GitHub repository (https://www.github.com/). At the end of Week 12
(2020-01-24, 23:59)(2020-01-27, 23:59), your public GitHub repository should contain your developed software (including source code, test suite, documentation on how to build, deploy, and use your software).- As agreed in your contract agreements, you have to publish it under an open-source license. So, don't forget to add a suitable license to your GitHub repository. In general, you have to publish your work under MIT license (https://opensource.org/licenses/MIT), except you already have agreed to another license in your contract agreement with the customer. However, please check if you re-used already published or existing code in your software. If so, you have to check whether the license of these code snippets is compatible with the MIT license. If not, you have to adjust your open-source license in complience with the license of the already exisiting code.
- In addition, also make sure that you don't violate copyright and related rights (this might especially hold for icons or pictures used in your software).
- Don't migrate the complete GitLab repository to GitHub -- only copy the final version of the source code and related documentation to the new GitHub repository and commit this as a whole. Make sure to remove all the diagrams and documents before pushing to GitHub, especially those which contain privacy data, such as names and matriculation numbers (that is also the reason why you are not allowed to migrate the complete project, as your commit history contains all the documents containing privacy-related data, even if you would remove it in the end.)
In the end, both GitLab and GitHub repositories should contain the same version of your software and corresponding documentation by the end of Friday (2020-01-24, 23:59) Monday (2020-01-27, 23:59). Don't forget to add the link to your public GitHub repository to your final progress report.