chore: Aggiunto nel README una descizione della struttura della codebase #39
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Cadienvan
requested changes
Oct 28, 2023
| # Contribuire | ||
| ## Struttura file e cartelle | ||
|
|
||
| Il repository è strutturato in cartelle, ognuna delle quali contiene un file `README.md` che ne descrive il contenuto. |
There was a problem hiding this comment.
Suggested change
| Il repository è strutturato in cartelle, ognuna delle quali contiene un file `README.md` che ne descrive il contenuto. | |
| Questo repository è strutturato in cartelle, ognuna delle quali contiene un file `README.md` che ne descrive il contenuto. |
|
|
||
| Il repository è strutturato in cartelle, ognuna delle quali contiene un file `README.md` che ne descrive il contenuto. | ||
|
|
||
| Questa è lista dettagliata delle cartelle |
There was a problem hiding this comment.
Suggested change
| Questa è lista dettagliata delle cartelle | |
| Segue una lista dettagliata dell'attuale suddivisione: |
|
|
||
| Questa è lista dettagliata delle cartelle | ||
|
|
||
| - `events`: contiene le note degli eventi a cui il progetto ha partecipato, organizzate per data, la quantità si consiglia di creare delle sottocartelle per working group e per anno |
There was a problem hiding this comment.
Suggested change
| - `events`: contiene le note degli eventi a cui il progetto ha partecipato, organizzate per data, la quantità si consiglia di creare delle sottocartelle per working group e per anno | |
| - `events`: Contiene le note degli eventi a cui il progetto ha partecipato, ordinate per data. |
Suggerisco di rimuovere il riferimento al WG anche perché agli eventi non partecipa un WG ma gli ambassador in toto.. O non ho capito io?
| Questa è lista dettagliata delle cartelle | ||
|
|
||
| - `events`: contiene le note degli eventi a cui il progetto ha partecipato, organizzate per data, la quantità si consiglia di creare delle sottocartelle per working group e per anno | ||
| - `guidelines`: contiene le linee guida del progetto, organizzate per working group |
There was a problem hiding this comment.
Questa cartella attualmente non esiste, non so se la metterei in questo momento..
|
|
||
| - `events`: contiene le note degli eventi a cui il progetto ha partecipato, organizzate per data, la quantità si consiglia di creare delle sottocartelle per working group e per anno | ||
| - `guidelines`: contiene le linee guida del progetto, organizzate per working group | ||
| - `meetings`: contiene le note dei meeting degli Ambassador organizzate per data, la quantità si consiglia di creare delle sottocartelle per working group e per anno |
There was a problem hiding this comment.
Suggested change
| - `meetings`: contiene le note dei meeting degli Ambassador organizzate per data, la quantità si consiglia di creare delle sottocartelle per working group e per anno | |
| - `meetings`: Contiene le note dei meeting degli Ambassador ordinate per data. |
Ho rimosso il suggerimento perché, seppur sensato, in questo momento la struttura non lo rispecchia e avrebbe senso una PR a parte che metta in ordine le cose qualora si andasse per quella strada, che io appoggio.
| - `events`: contiene le note degli eventi a cui il progetto ha partecipato, organizzate per data, la quantità si consiglia di creare delle sottocartelle per working group e per anno | ||
| - `guidelines`: contiene le linee guida del progetto, organizzate per working group | ||
| - `meetings`: contiene le note dei meeting degli Ambassador organizzate per data, la quantità si consiglia di creare delle sottocartelle per working group e per anno | ||
| - `templates`: contiene i template per la governance del progetto, es. testi per la nomina degli Ambassador |
There was a problem hiding this comment.
Suggested change
| - `templates`: contiene i template per la governance del progetto, es. testi per la nomina degli Ambassador | |
| - `templates`: Contiene i template per la governance del progetto, es. testi per la nomina degli Ambassador. |
| - `guidelines`: contiene le linee guida del progetto, organizzate per working group | ||
| - `meetings`: contiene le note dei meeting degli Ambassador organizzate per data, la quantità si consiglia di creare delle sottocartelle per working group e per anno | ||
| - `templates`: contiene i template per la governance del progetto, es. testi per la nomina degli Ambassador | ||
| - `wg`: contiene i regolamenti interni di ogni working group |
There was a problem hiding this comment.
Al momento la cartella non esiste, non la inserirei finché non ci sia veramente.
|
Ho lasciato alcune idee e suggerimenti, in generale il punto mi torna ma ci sono alcune cose che attualmente non abbiamo e inserirle creerebbe confusione. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Questo seconda descrizione anche se potrebbe sembrare ridodante ha l'obbiettivo di mettere a fuoco lo scopo di ogni cartella. Al contrario la sezione precedente a questa a quello invede di guidare chi atterra sulla codebase alla consultazione di un contenuto specifico.