Chociaż kod istnieje w celu kompilacji lub wykonania przez komputer, jest on również do odczytywania przez ludzi. Komputer nie dba o to, jak wygląda kod tak długo, jak jest to poprawna składnia. Można jednak wiele zrobić w zakresie formatowania i stylizacji kodu, aby uczynić go jeszcze bardziej czytelnym przez ludzi.
Są to głównie proste rzeczy, takie jak spójność wcięć, odstępów i długości linii. Każdy język ma swoje własne konwencje; każdy projekt projekt będzie miał własne specjalizacje tych konwencji. BeeWare nie jest wyjątkiem.
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.
Nie ogranicza się to jednak tylko do stylu kodu. Każda kontrola, którą można można obiektywnie zmierzyć, może być przeprowadzona jako część procedury pre-merge procedury. Może to obejmować:
- Sprawdzenie certyfikatu pochodzenia dewelopera, umowy licencyjnej twórcy lub innej procedury licencyjnej lub innej procedury licencjonowania wkładu.
- Ocena złożoności kodu
- Ocena pokrycia kodu
i wiele innych.
Beefore opiera się na procesie ciągłej integracji, który już używasz do uruchamiania zestawu testów przed scaleniem zatwierdzeń (np, Travis-CI). Testy Beefore są wykonywane jako niestandardowe uruchomienie testowe.
Jak pomóc
- Ulepszanie istniejących linterów
- Integracja nowych linterów i kontroli stylu (np. Java)
Dlaczego więc nazywa się to "Beefore"?
Sprawdza wszystkie rzeczy, które musisz mieć przed scaleniem poprawki. patch.