Anche se il codice esiste per essere compilato o eseguito da un computer, è anche per essere letto dagli esseri umani. Al computer non interessa l'aspetto del codice purché la sintassi sia valida. Tuttavia, si possono fare molte cose nella formattazione e lo stile del codice per renderlo ancora più leggibile dall'uomo.

Si tratta per lo più di cose semplici, come la coerenza nell'indentazione, spaziatura e lunghezza delle righe. Ogni lingua ha le sue convenzioni; ogni progetto avrà le proprie progetto avrà le proprie specializzazioni di tali convenzioni. BeeWare non fa eccezione.

Someone reviewing a patch still needs to check for correct logic, but these simple style-check tasks are easy to check programatically. Many text editors will (or have extensions that will) do this process for you - the task is called linting. Beefore is a tool that allows you to integrate these checks into your GitHub pre-merge procedure, in the same way that can integrate continuous integration and test suite compliance before merging.

Non si limita però solo allo stile del codice. Qualsiasi controllo che possa essere oggettivamente misurabile può essere eseguito come parte della procedura di pre di pre-fusione. Tra questi potrebbero esserci:

  • Verificare la presenza di un Certificato di origine dello sviluppatore, di un Accordo di licenza per i contributori o di un'altra procedura di licenza per i contributi. o un'altra procedura di licenza per i contributi.
  • Valutazione della complessità del codice
  • Valutazione della copertura del codice

e molti altri.

Beefore si appoggia al processo di integrazione continua che si già utilizzato per eseguire la suite di test prima di unire i commit (ad es, Travis-CI). I test di Beefore vengono eseguiti come test personalizzati.

Come aiutare

  • Migliorare i linters esistenti
  • Integrazione di nuovi linters e controlli di stile (ad esempio, Java)

Allora, perché si chiama "Beefore"?

Controlla tutte le cose che devono essere corrette prima di unire una patch. patch.