Skip to content

Commit dbf8fc3

Browse files
committed
docs: aggiunta file agents.md
1 parent dec38ac commit dbf8fc3

3 files changed

Lines changed: 630 additions & 108 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,15 @@ Se ti serve un aiuto, crea una issue su GitHub.
1818

1919
Per migliorare il sistema con cui sviluppiamo il codice, abbiamo deciso di adottare alcune linee guida per facilitare la collaborazione tra più persone.
2020

21-
22-
### Standard del codice
23-
24-
Per lo standard ufficiale riguardante i nomi e le strutture da utilizzare, visita la sezione [Standard](https://github.com/devcode-it/openstamanager/blob/master/.github/STANDARD.md).
25-
2621
### Codice di condotta
2722

2823
Per il momento non abbiamo adottato un vero e proprio codice di condotta, ma ti chiediamo di essere il più civile possibile nel comunicare con gli altri per questo progetto.
2924

3025
### Stile del codice
3126

32-
Utilizziamo principalmente due strumenti per mantenere consistente nel tempo lo stile del codice:
27+
Utilizziamo principalmente tre strumenti per mantenere consistente nel tempo lo stile del codice:
3328
- [PHP CS Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer)
29+
- [Rector](https://github.com/rectorphp/rector)
3430
- [EditorConfig](https://editorconfig.org)
3531

3632
PHP CS Fixer viene utilizzato per formattare automaticamente il codice PHP e aumentare la sua comprensibilità.
@@ -78,3 +74,20 @@ Cerchiamo di essere disponibili quanto possibile, ma non sempre riusciamo a risp
7874
## Testing
7975

8076
Abbiamo creato un **[repository per i tests automatici](https://github.com/devcode-it/openstamanager-tests)** apposito contenente scripts in Python per eseguire i test automatici.
77+
78+
## Struttura del codice
79+
80+
Per comprendere meglio la struttura del codice e le convenzioni utilizzate nel progetto, consulta la guida **[agents.md](../agents.md)** che contiene informazioni dettagliate su:
81+
82+
- Versioning e migrazioni del database
83+
- Punti di ingresso principali
84+
- Struttura delle directory
85+
- Convenzioni per il database
86+
- Architettura ORM e classi
87+
- Hooks e task schedulati
88+
- Struttura dei moduli
89+
- Sistema HTMLBuilder per i form
90+
- Funzioni helper e variabili globali
91+
- Best practice per lo sviluppo
92+
93+
Questa guida è utile sia per i nuovi sviluppatori che per chi desidera contribuire al progetto.

.github/STANDARD.md

Lines changed: 0 additions & 102 deletions
This file was deleted.

0 commit comments

Comments
 (0)