Nazywanie commitów

Ostatnio miałem małe Pair Programming poza pracą (tak można się w ten sposób uczyć!).

Padł zarzut że nie powinno się nazywać commitów w stylu “Create PatientService class” tylko jaka jest funkcjonalność dodana. Zgodzę się z tym. Z tym, że aby tak było to trzeba najpierw mieć napisaną całą funkcjonalność krok po krok, przejść process CodeReview (za pomocą Pull Request), następnie wyczyścić commity (git rebase interactive) i wtedy wychodzi nam jeden (kilka?) commitów mających domenowy sens. I tak staram się robić.

Niestety rzeczywistość obok mnie jest mniej różowa, czasem poprawka goni poprawkę. Wtedy siłą rzeczy commit wyglądają jak “Fix: change number variable to long”, “Add missing PatientService class”, “Filter itemsRepository by PartId”. Naprawdę niewiele zmienia gdy na początku commita doklei się ticket z JIRY czy inne TFS. W historii jest po prostu sieczka.

Przy okazji, a może przede wszystkim: How to Write a Git Commit Message

Reklamy
Opublikowano git | Otagowano , , , , | Dodaj komentarz

Literówki w kodzie, komentarzu i na głównej

Mam już taki wzrok, że widzę literówki i nie przepuszczam im. Po prostu taki już jestem, tak mój mózg pracuje. Oczywiście nie toczę wojen w zespołach o to. Są już automatyczne narzędzia które to wychwytują (dodatek ReSpeller do ReSharpera), a resztę sobie poprawię sam, to sama przyjemność.

Można więc myśleć, że to aż tak się nie zwraca bo w sumie kod się uruchomi niezależnie od tego czy klasa się będzie nazywać ArticleTpeConwerter czy ArticleTypeConverter. I że ten porządek, pomoże generalnie projektowi, ale przejdzie to na pewno niezauważone.

Ale, ale

Właśnie zdałem sobie sprawę, że te wszystkie niechluje, które się niczym nie przejmują (i walą literówki i nawet nie chce im się poprawiać po sobie) robią to samo z tekstami, które idą do klienta.

Inspiracja (można przeczekać minutę o CV, później jest o pracy):

Opublikowano Programowanie | Otagowano | 2 Komentarze

Reguła DRY – tip #1

DRY – Don’t Repeat Yourself. Łamanie tej reguły ma tyle twarzy, że postanowiłem każdy mały przykład wrzucać.

Gorszy kod:

string GetFilePath()
{
    return IsForDebug
        ? $@"{Folder}\{Name}.{Extension}.{VersionNumber}"
        : $@"{Folder}\{Name}.{Extension}";
}

Lepszy kod:

string GetFilePathBetter()
{
    var filePath = $@"{Folder}\{Name}.{Extension}";

    if (IsForDebug)
    {
        filePath += $".{VersionNumber}";
    }

    return filePath;
}

Wiem że nie powinno się sklejać ścieżki w ten sposób tylko użyć Path.Combine(). Przykład z kodu.

Po komentarzu @marfusios2 zdałem sobie sprawę, że można to ulepszyć do

string GetFilePathMaybeBetter()
{
    var postfix = IsForDebug
        ? $".{VersionNumber}"
        : "";

    return $@"{Folder}\{Name}.{Extension}{postfix}";
}

Ciągle jest jeden zbędny string, ale już zdecydowanie krótszy.

Opublikowano Programowanie | Otagowano , | 3 Komentarze

Moje lokalne standardy pracy z gitem

Dorobiłem się już kilku wypracowanych przez lata małych standardów przydatnych w pracy z gitem. Stosowane LOKALNIE, mają więc sens tylko w mojej lokalnej pracy i muszą być wyczyszczone przed wykonaniem PUSHA.

  • Rozpoczynanie od „−− ” – jest to commit, który jest tylko lokalny i powienien być na pewno w całości usunięty przez pushowaniem. Może to być lokalna podmiana bazy danych, jakaś zmiana ułatwiająca szukanie aktualnego buga.
  • „.” (kropka) – oznacza na tyle małą rzecz, że po prostu kropka
  • „…” – powinno być dołączone do poprzedniego commita (f – fixup gdy robimy interactive rebase). Niby można od razu zrobić git commit --amend, ale jednak jest częścią czegoś większego, gdzie chcę jeszcze przez jakiś czas mieć osobne commity.
  • „…prev” – trochę jak poprzednio tylko powinien byc doklejony do jednego z poprzednich commitów.
  • „wip” – skrót od „Work In Progress”, coś na szybko, bo nie miałem czasu wpisać właściwego opisu, trzeba było szybko sprawdzić coś na innym branchu etc.
  • „wip treść commita” – gdy jesteś w trakcie czegoś to lepiej to zaznaczyć na początku commita niż na końcu (wtedy wyglądało by „treść commita wip”)
  • „++ treść commita” – gdy jesteś w trakcie czegoś czegoś większego, a zmiana którą zrobiłeś (nie jest cześcią aktualnego feature’a) powinna pójść prosto na branch develop
Opublikowano git | Otagowano ,

MasterCoder – CODING KOKS FIREFOX

mastercoder

W dzisiejszej odsłonie reflektory sławy padają na konkurs MasterCoder. Wreszcie było mi dane sprawdzić się w rozwiązywaniu zadań algorytmicznych na czas. Każdego dnia zmagałem się z nowymi zadaniami programistycznymi (weekendy na szczęście były wolne na regenerację umysłu). O 20 wpadało nowe zadanie i zaczynała się jazda, kto pierwszy ten lepszy, ale przede wszystkim liczyła się jakość. Zazwyczaj wysyłałem odpowiedź o 22. Następnie czekanie do 8 kiedy to spływały wyniki i ewentualnie można było wysyłać ponowne rozwiązania zadań.

Właśnie ok tej 21:30 spadały na mnie najtrudniejsze decyzje. Czy już wysyłać? Czy może jeszcze dopieścić? Moje testy przechodzą, ale czy pokryłem wszystkie przypadki? Czy dobrze zrozumiałem opisany problem? Adrenalina, presja czasu, zmęczenie… Wykonujący się kod jest bezlitosny. Jakże odmienne warunki od tego co ma się na co dzień w pracy. Wszyscy wiedzą jaka jest proza życia.

morcinek-ranking-mastercoder-2016

Ranking finałowy i zaznaczony ja. No cóż, postarałem się, walczyłem jak lew;) i jadę na finał. Odbędzie się w sobotę w Łodzi podczas konferencji Mobilization. Pierwszy etap to „Jeden z dziesięciu”, do kolejnego przechodzą 3 osoby i będzie to już live coding. No cóż, trzymajcie kciuki 😀

DLA PRAWDZIWYCH WYMIATACZY KODU – sprawdź czy podołałbyś zadaniom konkursowym.

Moje rozwiązania zadań umieszczone na GitHubie: https://github.com/kmorcinek/MasterCode2016

Opublikowano Programowanie | Otagowano | 2 Komentarze

Otwórz gita w odpowiednim folderze

Taka mała rzecz a cieszy (dobra, dwie małe rzeczy).

Pod skrótem klawiszowym „Win+2” (czyli druga aplikacja która jest „pinned” do paska w Windows) otwiera mi się konsola gita. Moje podstawowe narzędzie pracy. I teraz trzeba tylko zmienić folder, w którym się uruchomi na ten, w którym projekcie aktualnie pracuję.

Klikamy właściwości tego programu (wprost z paska) i ustawiamy:

start-git-in-folder

Opublikowano Tip of the day | Otagowano

Immutable Value Object przesyłany/serializowany (np po SignalR)

Najbardziej popularnym Value Object jest Money. Dzisiejsza implementacja jest okrojona, bo chciałbym pokazać tylko jedną rzecz. W tym przykładzie instancje możemy tworzyć tylko poprzez metode Create() (taka fabryka). Konstruktor jest prywatny.

public class Money
{
    public static Money Create(decimal value, string currency)
    {
        // some additional checks
        return new Money(value, currency);
    }

    Money(decimal value, string currency)
    {
        Value = value;
        Currency = currency;
    }

    public decimal Value { get; }
    public string Currency { get; }
}

Pewnie dla tego przykładu lepiej mieć po prostu publiczny konstruktor z dwoma parametrami, ale mam wiele przykładów innych bardziej skomplikowanych Value Objects, gdzie podejście z prywatnym konstruktorem i kilkoma fabrykami walidującymi różne przypadki ma sens.

Czy można przesyłać immutable Value Object poprzez SignalR?

Taki obiekt nie przejdzie serializacji JsonSerializerem i nie może być przesłany SignalR’em. Uważam, że nie ma nic złego w przesyłaniu takiego immutable Money między clientem a serverem (obydwa w .NET, nie tylko webem żyje człowiek 😉 ). Czy ktoś uważa, że to złe podejście i trzeba tworzyć do tego DTO? Postawiłem na prostotę.

Rozwiązanie

Trzeba dodać attrybut [JsonConstructor] do konstruktora.

public class Money
{
    public static Money Create(decimal value, string currency)
    {
        // some additional checks
        return new Money(value, currency);
    }

    [JsonConstructor]
    Money(decimal value, string currency)
    {
        Value = value;
        Currency = currency;
    }

    public decimal Value { get; }
    public string Currency { get; }
}

Źródło: JSON.net: how to deserialize without using the default constructor?

Jak testować/rozkminiać takie rzeczy

Szlak by mnie trafił gdybym miał takie moje przemyślenia, przypuszczenia, POC testować na żywym projekcie, który się ileś tam uruchamia i potem muszę jeszcze sie przeklikać, żeby coś wywołać.

Izolujemy co istotne od tego co nieistotne i testujemy 🙂

Opublikowano Programowanie | Otagowano , , , | 2 Komentarze