Obwohl der Code existiert, um von einem Computer kompiliert oder ausgeführt zu werden, ist er auch auch dazu da, von Menschen gelesen zu werden. Einem Computer ist es egal, wie der Code aussieht wie er aussieht, solange er eine gültige Syntax hat. Man kann jedoch eine Menge tun, um Formatierung und Gestaltung des Codes tun, um ihn für Menschen noch lesbarer zu machen. für Menschen lesbar zu machen.
Dabei handelt es sich meist um einfache Dinge, wie die Einheitlichkeit der Einrückung, Abständen und Zeilenlängen. Jede Sprache hat ihre eigenen Konventionen; jedes Projekt wird seine eigenen Spezialisierungen dieser Konventionen haben. BeeWare ist da keine Ausnahme.
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.
Es ist jedoch nicht nur auf den Code-Stil beschränkt. Jede Überprüfung, die objektiv gemessen werden kann, kann als Teil des Pre-Merge Verfahrens durchgeführt werden. Dies könnte Folgendes umfassen:
- Prüfung auf ein Herkunftszertifikat für Entwickler, eine Lizenzvereinbarung für Mitwirkende Lizenzvereinbarung oder einem anderen Verfahren zur Lizenzierung von Beiträgen.
- Bewertung der Code-Komplexität
- Bewertung der Codeabdeckung
und viele andere.
Beefore ergänzt den kontinuierlichen Integrationsprozess, den Sie bereits verwenden, um Ihre Testsuite vor dem Zusammenführen von Übertragungen auszuführen (z. B., Travis-CI). Die Beefore-Tests werden als benutzerdefinierter Testlauf ausgeführt.
How to help
- Verbesserung der bestehenden Linters
- Integration neuer Linters und Stilprüfungen (z. B. Java)
So, why is it called "Beefore"?
Es prüft auf all die Dinge, die richtig sein müssen, bevor man einen Patch zusammenführt. Patch zusammenführt.