Wpisy z tagiem: software-development

Nowości na moim blogu:

Rzadko widzę sens w zmianie raz napisanych rzeczy. Ale teraz jak raz naszło mnie i postanowiłem odświeżyć swój artykuł "Tips for blogging developers".

Między innymi poprawiłem niespójności; trochę przegrupowałem wskazówki; jedną wskazówkę dodałem, jedną usunąłem. Wynik wygląda tak: https://devsilv.github.io/2020/04/08/tips-for-blogging-developers-v-2.html Nie są to zmiany duże, więc jeśli ktoś czytał wersję nr 1, to tutaj raczej nic nowego nie znajdzie – poza 1 wskazówką odnośnie podsumowywania. Natomiast… jeśli ktoś czekał głównie na poprawę niespójności (o ile tacy są ;) ), prawdopodobnie będzie chcieć przejrzeć.

Bardzo chętnie przyjmę wszelkie oceny, recenzje i w ogóle komentarze. Jestem dumny z tego artykułu o tyle, że jest tak obszerny, a mimo wydaje mi się spójny (a co za tym idzie, uważam go za warty publikacji). To dla mnie duża zaleta jako blogera. Ale być może niektóre wskazówki nie mają zastosowania, lub mają błędne założenia? Chętnie przyjmę krytykę.

Miłego czytania. :)

Przy okazji:

Tak, zdaję sobie sprawę, że obecnie ogólnie może artykuły na moim blogu być ciężko być czytać z uwagi na przynajmniej dwa punkty:

• brak zwijania sekcji (a niemal wszystkie mają po kilka akapitów);
• zbyt mało różniące się formatowanie nagłówków na poszczególnych poziomach.

Zmiany na blogu nie są teraz moim priorytetem; niemniej chciałbym to zmienić, gdy tylko znajdę chęci / czas / zapał… Nadto blog używa Bootstrapa, a mnie jakoś nie pasuje zmienianie jego stylów, by pasowały do mojej wizji. Więc zmiana chyba będzie poważniejsza – żeby znów mieć własne style CSS (teraz już może w SASS)…

PS. Oczywiście zapomniałem: pierwsza wersja artykułu tutaj, proszę -> https://devsilv.github.io/2018/07/10/tips-for-blogging-developers.html I jeszcze dla formalności: minęło od jej publikacji ok. rok i 8 miesięcy.

#blog #news #artykuł #github #feedback #język-angielski

Oto, jak człowiek może sobie sam utrudnić życie – https://github.com/devsilv/DevSilv-jsgame-1/issues/7 :D

1. wszystkie teksty na GitHubie zapisuję wyłącznie za pomocą małych liter oraz kropki na końcu zdania;
2. w opisach zmian w Gicie rozpoczynam zdania wielką literą oraz nie stosuję kropki;
3. w komentarzach w projekcie, do którego prowadzi powyższy link, rozpoczynam zdania wielkimi literami i stosuję kropkę.

Zadałem nagle sobie pytanie: jak to ujednolicić?

Co ciekawe, dla wszystkich trzech miejsc są powody, dla których wybrałem właśnie taki zapis. Zawsze denerwował mnie zapis wielką literą bez kropki (szczególnie w języku, który znam mniej niż rodzimy – "hm, to już koniec zdania, czy jeszcze może nie?"), więc:

1. na GitHubie wybrałem małe litery, bo mogłem, oraz kropki, bo inaczej nie dałoby się zapisywać normalnie wielozdaniowych opisów;
2. w Gicie sugerowałem się jakąś rekomendacją odnośnie wielkiej litery i braku kropki, ale teraz nie mogę sobie przypomnieć, jaką – w każdym razie była ważniejsza niż moje wrażenie estetyczne;
3. w komentarzach w tym projekcie (bo ogólnie bywa różnie :( ) chciałem być możliwie najbardziej poprawny językowo – raz dlatego, żeby od razu widzieć, czy komentarz nie został w połowie przerwany/urwany (np. przy przenoszeniu kodu), a dwa dlatego, że zapisuję je po angielsku.

Żeby nie było, że tylko opowiadam o problemach, a ich nie rozwiązuję, tu kilka przykładowych lektur, gdyby ktoś był zainteresowany tematem:

• https://www.gnu.org/prep/standards/html_node/Comments.html
• https://softwareengineering.stackexchange.com/questions/17766/what-are-your-thoughts-on-periods-full-stops-in-code-comments
• https://archive.zhimingwang.org/blog/2015-08-05-switching-to-capitalized-commit-messages.html
• https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines

I ciekawy jestem, jak wy zapisujecie te rzeczy. Czy trzymacie się jednego stylu, czy zasady "wszystko jedno, byle zrozumiale"?

#GitHub #VCS #Konwencje #Styl-pisania #Software-development #Sam-sobie-narobiłem #Feedback