diff --git a/README.md b/README.md index 24b1f0b1297850f3a0b502213f571b91b37b90c8..8fcaa9c20c789c58458959d1e5f989e01d3948a8 100644 --- a/README.md +++ b/README.md @@ -1,92 +1,73 @@ -# APIChatGPT +# PROJET : GPT Programmeur +## But du projet +Réaliser une application Web, qui permet de demander à *ChatGPT* de créer une fonction avec des tests unitaires dans un langage de programmation donné. +## Dates limites +- point d'étape : **mardi 14 février** matin : présentation des tests et du worklow CI/CD. +- dépôt final : **dimanche 19 février** minuit -## Getting started +## Moyens +Langage de développement : au choix +Framework Web : au choix +Dépôt GIT : https://gitlab.univ-lorraine.fr -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)! +## Langages cibles -## Add your files +| Groupes | Langages | Membres | +| -------- | ----------------- | ----------------------------------- | +| Groupe 1 | *Python / Prolog* | Malavasi / Mandler / Pozzo Di Borgo | +| Groupe 2 | *Java / Eiffel* | Mingot / Signorelli / Wissle | +| Groupe 3 | *PHP / Haskell* | Ako’O Obono / Doan / Paulin | -- [ ] [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.univ-lorraine.fr/signorel2u/apichatgpt.git -git branch -M main -git push -uf origin main -``` +## Description de la page WEB -## Integrate with your tools +Un exemple de formulaire Web est fourni dans le ficheir `codeur_gpt.html` -- [ ] [Set up project integrations](https://gitlab.univ-lorraine.fr/signorel2u/apichatgpt/-/settings/integrations) +Le formulaire doit contenir les élements suivants : +- une zone de description de la fonction, par exemple : + - « Résoudre une équation du second degré. » + - « Trier une liste de mots » + - « Tester si un mot est un palindrome. » + - « Calculer le nombre d'occurences de chaque mot dans un texte. » +- une zone de saisie du nombre de tests unitaires +- un bouton pour lancer la création du programme +- un popup menu pour choisir le langage de programmation entre les deux définis pour le groupe +- une zone éditable d’affichage du programme +- une zone éditable avec la liste des tests +- un bouton pour relancer le passage des tests après modification du programme ou des tests -## Collaborate with your team +Votre logiciel de création de fonction devra pouvoir être testé sans accès à ChatGPT, ni Internet. Vous utiliserez donc un *mock* (https://en.wikipedia.org/wiki/Mock_object) avec des réponses prédéfinies pour simuler le comportement de l'accès à *ChatGPT*. -- [ ] [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) +On mettra en place avec .gitlab-ci.yml un workflow CI/CD d'installation, de tests et de déploiement du projet. On peut s'inspirer de ce modèle adapaté à votre framework de développement : https://gitlab.com/gitlab-org/project-templates/laravel/-/blob/main/.gitlab-ci.yml -## Test and Deploy +On mettra en place des scénarios de tests fonctionnels avec le framework *Selenium*. -Use the built-in continuous integration in GitLab. +La fonction créée devra passer et valider les tests générés par *ChatGPT*. Comme dans le programme *Mira* (voir ci-dessous), il peut être nécessaire de demander à *ChatGPT* de refaire le programme pour qu'il passe les tests. On limitera le nombre d'itérations à 10, et on mettra un message d'erreur si la fonction ne peut pas être validée. -- [ ] [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) -*** +## Itérations de développement +1. Un seul langage de programmation cible, pas de validations des tests, pas de modification du programme et des tests, pas d'itérations de *refactoring* auprès de ChatGPT. +2. Ajout de la validation des tests sans *refactoring*, vous mettrez un message pour indiquer si certains tests ne passent pas. +3. Ajout de la modification du programme et des tests par l'utilisateur. +4. Ajout des itérations de *refactoring* auprès de *ChatGPT*. +5. Ajout du second langage de programmation. -# Editing this README +## Références +Ces sources devraient être utiles : +- *Mira*, un programme en Rust qui crée des programmes Rust via GPT-3 : https://gitlab.com/corpsmoderne/mira +- API de *ChatGPT* : + - https://platform.openai.com/docs/guides/code + - https://beta.openai.com/docs/api-reference + - https://openai.com/api/ -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. +## Langages de programmation -## 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. +- PHP : https://www.php.net +- Python : https://www.python.org +- Java : https://www.oracle.com/java/ +- Prolog : https://www.swi-prolog.org +- Haskell : https://www.haskell.org +- Eiffel : https://www.eiffel.org