From 8f5a7dce7495fe09fcf1dfcd8e295a2d5b2189c5 Mon Sep 17 00:00:00 2001 From: Sofiane Lasri <alasri250@gmail.com> Date: Fri, 28 Oct 2022 11:59:37 +0200 Subject: [PATCH] readme --- README.md | 113 ++++++++++++------------------------------------------ 1 file changed, 25 insertions(+), 88 deletions(-) diff --git a/README.md b/README.md index aac4721..4e958d2 100644 --- a/README.md +++ b/README.md @@ -2,91 +2,28 @@ -## Getting started - -To make it easy for you to get started with GitLab, here's a list of recommended next steps. - -Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! - -## Add your files - -- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files -- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: - -``` -cd existing_repo -git remote add origin https://gitlab.sl-projects.com/SofianeLasri/tp-php-lpprism.git -git branch -M main -git push -uf origin main -``` - -## Integrate with your tools - -- [ ] [Set up project integrations](https://gitlab.sl-projects.com/SofianeLasri/tp-php-lpprism/-/settings/integrations) - -## Collaborate with your team - -- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) -- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) -- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) -- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) -- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) - -## Test and Deploy - -Use the built-in continuous integration in GitLab. - -- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) -- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) -- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) -- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) -- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) - -*** - -# Editing this README - -When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template. - -## Suggestions for a good README -Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. - -## Name -Choose a self-explaining name for your project. - -## Description -Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. - -## Badges -On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. - -## Visuals -Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. - -## Installation -Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. - -## Usage -Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. - -## Support -Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. - -## Roadmap -If you have ideas for releases in the future, it is a good idea to list them in the README. - -## Contributing -State if you are open to contributions and what your requirements are for accepting them. - -For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. - -You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. - -## Authors and acknowledgment -Show your appreciation to those who have contributed to the project. - -## License -For open source projects, say how it is licensed. - -## Project status -If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers. +## Information pour M.Gagné +Je suis désolé, mais j'ai vraiment du mal avec votre façon de faire. Les pratiques réalisées sur le TP5 ne sont pas +bonnes pour plusieurs raisons. + +**Premièrement**, même si je comprends bien que créer plusieurs contrôleurs est rébarbatif, et qu'il peut être intéressant +de toute centralisé comme nous l'avions fait avec les vues, ici ce n'est pas une bonne idée. Le problème étant que les +tables gérées par les modèles n'ont pas les mêmes noms de méthodes, ni de propriétés, il serait difficile de créer un +contrôleur unique pour chaque modèle sans devoir implémenter du code spécifique. + +Bien sûr, nous pourrions toujours les renommer en un nom plus général, me diriez-vous. Ainsi on règlerait le problème des noms de méthodes +comme `getAllAuteurs()`. Cela est d'ailleurs compatible avec les pages individuelles. Mais cela ne corrigera pas le problème du nom des propriétés. + +En effet, si pour un livre nous allons utiliser son année de parution dans sa description, pour un auteur nous allons plutôt +utiliser son année de naissance. Même en supprimant les descriptions superflues que j'ai ajouté aux liens, il reste la +question de pouvoir récupérer l'identifiant unique de chaque objet. Encore une fois, les noms sont différents. + +Nous pourrions encore et toujours trouver une solution, mais cela ne fera que contourner le problème qui est que +centraliser tous les contrôleurs de ces contrôleurs, en sachant que nous n'avons qu'une seule vue, n'est pas une bonne +idée. + +**Nous en venons au deuxième problème**. Avoir centralisé les vues est une très bonne idée. Cependant, cela signife que +leur contenu doit être géré dans les contrôleurs. Cela ne devrait pas poser de problème, sauf si nous avons décidé de +centraliser aussi. Pour palier à ce problème, il faudrait alors revoir la manières dont sont créés les modèles. Je +suppose qu'il s'agit là du sujet des prochains TP. + \ No newline at end of file -- GitLab