Přestože kód existuje proto, aby byl zkompilován nebo spuštěn počítačem, je to také aby ho mohli číst lidé. Počítači je jedno, jak kód vypadá jak vypadá, pokud má platnou syntaxi. Nicméně je toho hodně, co můžete udělat ve formátování a stylování kódu, aby byl kód ještě čitelnější. pro lidi.
Většinou se jedná o jednoduché věci, jako je důslednost v odsazování, řádkování a délky řádků. Každý jazyk má své vlastní konvence. projekt bude mít své vlastní specializace těchto konvencí. BeeWare není výjimkou.
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.
Neomezuje se však pouze na styl kódu. Jakákoli kontrola, která může být lze objektivně změřit, lze provést jako součást kontroly před sloučením. postupu. To může zahrnovat:
- Kontrola certifikátu původu vývojáře, licence přispěvatele nebo jiný postup licencování příspěvků.
- Hodnocení složitosti kódu
- Vyhodnocení pokrytí kódu
a mnoho dalších.
Beefore navazuje na proces kontinuální integrace, který jste již používáte ke spuštění testovací sady před sloučením revizí (např, Travis-CI). Testy Beefore se provádějí jako vlastní běh testů.
How to help
- Zlepšení stávajících linters
- Integrace nových linterů a kontrol stylů (např. Java)
So, why is it called "Beefore"?
Zkontroluje všechny věci, které musíte mít správně před sloučením a záplatu.