Skip to content

Latest commit

 

History

History
120 lines (108 loc) · 6.85 KB

CONTRIBUTING.md

File metadata and controls

120 lines (108 loc) · 6.85 KB
Raw

Contribuisci a The Bocchette 2

Il team di The Bocchette 2 è felice per tua iniziativa di contribuire, ma prima ti chiediamo di seguire le istruzioni qui per avere info su come contribuire al meglio.

Nuovo Issue

Prima di inizare

  • Cerca un Issue già esistente che è simile al tuo, in questo modo eviteremo duplicati.
  • Se è un problema riguardante la sicurezza, usa: Segnala una vulnerabilità di sicurezza. Si prega di non segnalare vulnerabilità di sicurezza tramite Issue pubblici.

Passaggi per contribuire

  • Sciegli il tipo di Issue:
  • Compila il modulo: Completa le informazioni richieste nel modulo, fornisci abbastanza informazioni in maniera chiara. Seguendo questi requisiti è più probabile che il tuo problema/richiesta venga compreso e implementato/risolto.

Grazie per aver contribuito a rendere migliore The Bocchette 2! 🚀🎉

Risolvi un Issue

Prima di iniziare

  • Assicurati di avere istallato Git nel tuo PC.
  • Clona il repository da GitHub usando il comando: git clone https://github.com/Croc-Prog-github/The-Bocchette-2.git

Passaggi per contribuire

  1. Sciegli un Issue: Scegli un problema dal registro degli Issue o apri un nuovo issue.
  2. Indica il tuo impegno: Assegna a te stesso l'Issue per indicare che stai lavorando su di esso.
  3. Crea il tuo ramo: Crea un nuovo Branch separato, per implementare Commits sul tuo contributo. Per creare un nuovo ramo usa il comando:
git checkout -b branch-name
  1. Modifica: Fai le tue modifiche/implementazioni seguendo lo stile di programmazione e usando le informazioni fornite nel Issue.
  2. Commissiona: Fai il commit delle tue modifiche, usa il comando:
git commit -m "Description of your commit"
  1. Update nel tuo branch: Pusha il tuo branch, usa il comando:
git push origin branch-name
  1. Pull Request: Apri una Pull Request sul repository. Assicurati di descrivere chiaramente le tue modifiche.
  2. Attendi che la tua Pull Request venga revisionata, ti forniremo ulteriori dettagli nei commenti.

Grazie per aver contribuito a rendere migliore The Bocchette 2! 🚀🎉

Stile di programmazione

Lo stile di programmazione di The Bocchette 2, serve per facilitare il modo di revisionare il codice tra Contributori e Revisori, creando così un metodo comune e velocizzando il lavoro.

HTML

Regole per ottimizzare lo stile del codice per il linguaggio HTML:

  • L'elemento <script></script>
    • Se contine JS và definito dopo la chiusura di </body> e </html>, ci possono essere eccezioni, se lo script ha a che fare con il caricamento "anticipato" di qualcosa.
    • Se contiene la definizione per file JS, deve essere dichiarato dentro <head></head>, più precisamente dove c'è il commento <!-- Content -->, sotto l'ultima dichiarazione (dall'alto verso il basso). Esempio:
    <head>
  <!-- Content -->
  <script src="/Script.js"></script>
</head>
    • Negli <script></script> che contengono JS, subito dopo <script>, va scritto un commento che descriva brevemente il comportamento dello script. Esempio:
    <script> //Comportamento dello script
  // JS
</script>
  • Per l'elemento <style></style>
    • Se contine CSS và definito dopo la chiusura di </body> e </html>.
    • Se contiene la definizione per file CSS, deve essere dichiarato dentro <head></head>, più precisamente dove c'è il commento <!-- Content -->, sotto l'ultima dichiarazione (dall'alto verso il basso). Esempio:
    <head>
  <!-- Content -->
  <link rel="stylesheet" href="/Style.css">
</head>
  • Per tutti gli altri elementi, predefinitivamente, l'ordine degli attributi è: <div name="" id="" class="" style=""></div>.
    • L'attributo name="" è utilizzato come annotazione a scopo di riferimento per un particolare punto di codice.
    • Non preferiamo usare id per assegnare css ai singoli elementi, ma usiamo direttamente per i singoli elementi l'attibuto style="". Ovviamente per elementi che si ripetono si utilizza class="".

JavaScript/TypeScript

Regole per ottimizzare lo stile del codice per il linguaggio JS/TS:

  • Quando bisogna effettuare un'unione, stringa-numero, preferiamo utilizzare console.log("Counter: " + VarCounter) anzichè console.log(Counter: ${VarCounter}).
  • Quando bisogna interaggire con l'ID di qualcosa, preferiamo evitare l'uso di variabili e di aquisirlo direttamente, così, esempio:
document.getElementById("ID").innerText = "New text";

Ovviamente se è necessario usare delle variabili, si può bypassare questa regola.

  • Se una funzione ha un ruolo determinante ed è lunga, è preferibile inserire un commento, subito dopo la parentesi graffa, che ne descriva brevemente il comportamento, così:
function name(params) { //Compotamento della funzione
  // JS
}
  • Preferibilmente vi chiediamo di evitare di inserire troppi commenti, specialmente per le singole righe di codice. In questo modo il codice diventa più fluido da leggere. Inserite commenti per le righe quando necessario.
  • Quando dovete commentare più righe di codice, vi chiediamo di iniziare con il commento, poi le righe di codice ed infine una doppia andata a capo. Quando invece bisogna commentare una singola riga, posiziona il commento alla fine e se presente una sezione di codice, vai due volte a capo.
// Commento per una sezione di righe di codice
let id = document.getElementById("ID")
confirm.toString().length
id.textContent = 'abc'

F().length = 1 // Commento per una sola riga

CSS

Regole per ottimizzare lo stile del codice per il linguaggio CSS:

  • Preferibilmente, quando ci sono molte Regole di css, usate doppia andata a capo per spaziare Regole che riguardano altri elementi, invece mettete vicine le regole per lo stesso elemento.
body {
  cursor: default;
}
body:after{
  cursor: pointer;
}

#OtherElement{
  background: red;
}
#OtherElement:hover{
  background: blue;
}