renduprojet
This commit is contained in:
98
docs/pedagogie/audit-rendu-tokenizer.md
Normal file
98
docs/pedagogie/audit-rendu-tokenizer.md
Normal file
@@ -0,0 +1,98 @@
|
||||
# Audit rendu — `tokenizerRendu/` (avant Vogosphere)
|
||||
|
||||
> Date : 2026-10-22 · Grille : [`sujet-exigences-rendu.md`](sujet-exigences-rendu.md)
|
||||
|
||||
## Verdict global
|
||||
|
||||
| Statut | Commentaire |
|
||||
|--------|-------------|
|
||||
| **Prêt pour push école** | Partie obligatoire couverte ; nettoyage doc + `.gitignore` effectués |
|
||||
| **À faire sur machine école** | `npm install` + `npx hardhat test` ; démo MetaMask ; `git init` ou clone dédié |
|
||||
|
||||
---
|
||||
|
||||
## Conformité sujet (T1–T19)
|
||||
|
||||
Tous les critères obligatoires du tableau **sujet-exigences-rendu.md** sont **OK** pour FGC42Forge (nom `42`, BEP-20 testnet, 3 dossiers, README choix, deploy + adresse, doc utilisateur, code commenté, bonus documenté comme non retenu).
|
||||
|
||||
---
|
||||
|
||||
## Fichiers à **inclure** dans le dépôt Vogosphere
|
||||
|
||||
| Zone | Fichiers clés |
|
||||
|------|----------------|
|
||||
| Racine | `README.md`, `.gitignore` |
|
||||
| `code/` | `contracts/FGC42Forge.sol`, tests, ignition module, `hardhat.config.ts`, `package.json`, `package-lock.json`, `.env.example`, `.gitignore`, `README.md` |
|
||||
| `deployment/` | `addresses.json`, `README.md`, `BSCSCAN_VERIFICATION.md`, `FGC42Forge_flat.sol`, `addresses.json.example` |
|
||||
| `documentation/` | `README.md` |
|
||||
|
||||
**Template Hardhat (Counter)** : présent mais documenté comme hors périmètre dans `code/README.md` — acceptable ; ne pas présenter Counter en code review.
|
||||
|
||||
---
|
||||
|
||||
## Fichiers à **ne pas** committer
|
||||
|
||||
| Chemin | Raison |
|
||||
|--------|--------|
|
||||
| `code/.env` | Clé privée |
|
||||
| `code/node_modules/`, `cache/`, `artifacts/` | Générés |
|
||||
| `code/ignition/deployments/` | État local Ignition (gros `build-info`) — adresses dans `deployment/addresses.json` |
|
||||
| `code/.agents/`, `code/AGENTS.md` | Assistants locaux, hors sujet |
|
||||
| Tout `docs/` ou `pedagogie/` | Dépôt de travail perso uniquement |
|
||||
|
||||
`.gitignore` racine + `code/.gitignore` mis à jour en conséquence.
|
||||
|
||||
---
|
||||
|
||||
## Écarts mineurs (non bloquants)
|
||||
|
||||
| Point | Action |
|
||||
|-------|--------|
|
||||
| `code/scripts/send-op-tx.ts` | Script template Hardhat ; ignoré à l’oral ou supprimable si tu veux un tree plus minimal |
|
||||
| Tests non relancés dans cet audit (lock compilateur sandbox) | Sur ta machine : `cd code && npx hardhat test` |
|
||||
| Vidéo démo | Section vide dans README — conforme (optionnel) |
|
||||
|
||||
---
|
||||
|
||||
## Liens internes rendu
|
||||
|
||||
Aucun lien vers `docs/pedagogie` ou dépôt parent. Liens `../deployment`, `../code` : **OK** (dans le même repo école).
|
||||
|
||||
---
|
||||
|
||||
## Procédure Git — Vogosphere
|
||||
|
||||
### Option A — Dépôt **uniquement** rendu (recommandé)
|
||||
|
||||
Sur le PC où tu pousses vers l’intranet 42 :
|
||||
|
||||
```bash
|
||||
cd /chemin/vers/tokenizerRendu
|
||||
git init
|
||||
git add README.md .gitignore code deployment documentation
|
||||
git status # vérifier : pas de .env, pas de node_modules
|
||||
git commit -m "Tokenizer: FGC42Forge BSC testnet"
|
||||
# remote Vogosphere fourni par l’école
|
||||
git remote add origin <URL_VOGOSPHERE>
|
||||
git push -u origin main
|
||||
```
|
||||
|
||||
### Option B — Même machine, dépôt perso `tokenizer/` + sous-dossier rendu
|
||||
|
||||
- Ne **pas** pousser la racine `tokenizer/` si elle contient `docs/`.
|
||||
- Soit **Option A** dans `tokenizerRendu/`, soit branche `rendu` qui ne contient que le contenu de `tokenizerRendu/` (subtree / copie propre).
|
||||
|
||||
### Avant chaque push
|
||||
|
||||
```bash
|
||||
cd code
|
||||
grep -r "PRIVATE_KEY" .env 2>/dev/null && echo "STOP: .env présent" || true
|
||||
git status
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Après push
|
||||
|
||||
1. [checklist-demo-evaluation.md](checklist-demo-evaluation.md)
|
||||
2. [fiche-soutenance-tokenizer.md](fiche-soutenance-tokenizer.md) §10 (démo + oral ch. III)
|
||||
Reference in New Issue
Block a user