feat : Ajout d'un CHANGELOG.md

.gitea/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,23 @@
+---
+
+name: "Merge Request"
+about: "Template de MR"
+title: "[#NUMERO_TICKET] TITRE TICKET"
+ref: "main"
+
+---
+
+| Numéro du ticket | Titre du ticket | 
+|------------------|-----------------|
+|                  |                 |
+
+## Description de la PR
+
+## Modification du .env
+
+## Check list
+
+- [ ] Pas de régression
+- [ ] TU/TI/TF rédigée
+- [ ] TU/TI/TF OK
+- [ ] CHANGELOG modifié

CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+Liste des évolutions du projet Ferme
+
+## [0.0.0]
+### Parameters
+Ajouter dans le fichier .env
+- DEFAULT_URI
+- DATABASE_URL
+
+### Added
+
+### Changed
+
+### Fixed

README.md

@@ -17,6 +17,16 @@ make install
 ```
 Dans le cas ou le `make start` plante à cause du port de la bdd, il faut modifier **POSTGRES_PORT** dans le fichier .env.docker.local, remplacer le par un port disponible.
 
+### Configuration xdebug
+Pour configurer xdebug, il faut ajouter un serveur sur phpstorm. <br>
+Pour cela, il faut aller dans **Settings > PHP > Servers** <br>
+* Name : ferme-docker
+* Host : localhost
+* Port : 8080
+* Path : File/Directory -> l'endroit où est stocké votre projet et le path -> /var/www/html
+
+Pour que xdebug fonctionne sur windows, il faut modifier la variable **XDEBUG_CLIENT_HOST** par votre ip local
+
 ## Utilisation du projet
 ### Backend
 L'api est disponible sur http://localhost:8080/api
@@ -31,3 +41,21 @@ Pour le frontend, il suffit de taper la commande suivante qui va lancer le serve
 make dev-nuxt
 ```
 Le front sera accessible sur http://localhost:3000
+
+## Commandes utiles
+Pour restart le container
+```bash
+make restart
+```
+Pour lancer les TU
+```bash
+make test
+```
+Pour accéder au container et lance des commandes
+```bash
+make shell
+```
+Pour clear le cache Symfony
+```bash
+make cache-clear
+```

commit-msg

@@ -0,0 +1,31 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+MSG_FILE="${1}"
+FIRST_LINE="$(head -n 1 "$MSG_FILE" | tr -d '\r')"
+
+# Autoriser commits auto-générés par git
+if [[ "$FIRST_LINE" =~ ^Merge\  ]]; then
+  exit 0
+fi
+
+# Types autorisés (MINUSCULES uniquement)
+# Optionnel: scope => feat(auth) : ...
+REGEX='^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\([a-z0-9._-]+\))?\ :\ .+'
+
+if [[ ! "$FIRST_LINE" =~ $REGEX ]]; then
+  echo "❌ Message de commit invalide."
+  echo ""
+  echo "➡️ Format attendu : <type>(<scope optionnel>) : <message>"
+  echo "➡️ Types autorisés (minuscules uniquement) :"
+  echo "   build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test"
+  echo ""
+  echo "✅ Exemples :"
+  echo "  feat : add login page"
+  echo "  fix(auth) : prevent null token crash"
+  echo "  docs : update README"
+  echo ""
+  echo "❌ Exemple refusé :"
+  echo "  Feat : add login page"
+  exit 1
+fi

makefile

@@ -87,7 +87,9 @@ cache-clear:
 
 copy-git-hook:
 	$(EXEC_PHP) cp pre-commit .git/hooks/
+	$(EXEC_PHP) cp commit-msg .git/hooks/
 	$(EXEC_PHP) chmod a+x .git/hooks/pre-commit
+	$(EXEC_PHP) chmod a+x .git/hooks/commit-msg
 
 shell:
 	$(EXEC_PHP_INTERACTIVE) bash