diff --git a/README.md b/README.md index 71523403173d7cb32e06594544a4837de4817ecd..8354fec46f4c100dacdd3192711fb59b2674c1de 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ # Scoring program +This TP is based on a real-life situation that will enable you to put into practice the concepts covered during the presentations. You are part of a team working on a project entitled "Scoring". + ## Specifications ### Objective -To compare the predictions from `predict.txt` against the correct answers in `solution.txt` and compute various metrics: accuracy, mean squared error(MSE). +The aim of this program is to compare the predictions from `predict.txt` against the correct answers in `solution.txt` and compute various metrics: accuracy, mean squared error(MSE). ### Format of files @@ -65,4 +67,15 @@ Note that the MSE between two files would be the average of the squared errors f <li>Post-release maintenance: Even after the release, be prepared to fix any unforeseen bugs and possibly update the program based on user feedbacks or external contributions.</li> </ol> +The following steps have been prepared and arranged sequentially for your execution: +* [Setup](0-Setup.md) +* [MSE](a-MSE.md) +* [Input validation](b-INPUT-VALIDATION.md) +* [Logging](c-LOGGING.md) +* [Release](i-RELEASE.md) + +## Resources and useful links +* Git: + * [ASARD](resources/Git.pdf) + * [ANF QUALITE LOGICIELLE 2023](https://gitlab.in2p3.fr/ri3/ecole-info/2023/anf-qualite-logicielle/-/raw/main/ressources/presentations/slides/git.pdf?inline=false) diff --git a/a-MSE.md b/a-MSE.md index e6516490bf1929e734a30538c13fe96fe2b47d48..3a497105169c23b61916c84ce77ed9c0fe445962 100644 --- a/a-MSE.md +++ b/a-MSE.md @@ -267,7 +267,7 @@ then select Create merge request. ## Approve a merge request -The code reviewer does run all the tests again and ensures that the features `MSE` and `unittest` have been accurately implemented. If something goes wrong, the reviewer communicates these findings to the developer and tester for rectification. If everything is OK, click on `Approve`. +The code reviewer does run all the tests again and ensures that the features `MSE` and `testing` have been accurately implemented. If something goes wrong, the reviewer communicates these findings to the developer and tester for rectification. If everything is OK, click on `Approve`. ## Merge `a_MSE` into `develop` diff --git a/resources/Git.pdf b/resources/Git.pdf new file mode 100644 index 0000000000000000000000000000000000000000..38d85228c43a8ffb0a1ef435f0381c2229192654 Binary files /dev/null and b/resources/Git.pdf differ