Custom geek materials

Почему у программирования поплыла запятая?

2022-10-12T08:46:41.909Z

Числа с плавающей запятой в англоязычной литературе называются числа с плавающей точкой (от англ. floating point). Такое различие связано с тем, что в русскоязычной литературе принято отделять дробную часть числа запятой, а в европейской и американской - точкой.

Хранение чисел с плавающей запятой работает по стандарту IEEE 754 (1985 г). Для работы с числами с плавающей запятой на аппаратурном уровне к обычному процессору добавляют математический сопроцессор (FPU, floating point unit).

Типы с плавающей запятой

Рисунок демонстрирует, как распределяются биты в числах с плавающей запятой разных разрядностей, где

S - Sign (знак);
E - Exponent (8(11) разрядов поля порядка, экспонента);
M - Mantissa (23(52) бита мантиссы, дробная часть числа).

Также на рисунке показана так называемая, мнимая единица, она всегда есть в самом старшем разряде мантиссы, поэтому её всегда подразумевают, но в явном виде не хранят, экономя один бит информации.

Если попытаться уложить весь стандарт в два предложения, то получится примерно следующее: получить число в соответствующих разрядностях возможно по формулам:

Формулы расчёта значения числа с плавающей запятой

Например: +0,5 = 2 в -1й степени поэтому, число будет записано как

  0_01111110_00000000000000000000000,

то есть знак равен 0, мантисса равна 0, порядок равен 127 - 1 = 126, чтобы получить следующие результаты вычислений:

-1 в нулевой степени - положительный знак;
умножить на порядок 2 в степени 126-127, то есть в -1й = 0,5;
и умножить на мантиссу 1 + 0.

То есть, 1 * 0,5 * (1 + 0) = 0,5. Отсюда становится очевидно, что чем сложнее мантисса и чем меньше порядок, тем более точные и интересные числа мы можем получить.

А запятая-то куда поплыла?

Возьмём для примера число -0,15625, чтобы понять как его записывать, откинем знак, это будет единица в разряде, отвечающем за знак, и посчитаем мантиссу с порядком. Представим число как положительное и будем от него последовательно отнимать числа, являющиеся отрицательными степенями двойки, чтобы получить максимально близкое к нулю значение.

Значения степеней двойки

Очевидно, что -1 и -2 степени отнять не получится, поскольку мы явно уходим за границу нуля, а вот -3 прекрасно отнимается, значит порядок будет 127 - 3 = 124, осталось понять, что получится в мантиссе. Видим, что оставшееся после первого вычитания (0,15625 - 0,125) число - это 2 в -5й степени. Значит в мантиссе пишем 01 и остальные нули, то есть слева направо указываем, какие степени после -3 будут нужны, а именно, -4 не нужна, ставим 0, а -5 нужна, ставим 1. Довольно очевидно, что при подсчёте других чисел нам так не повезёт, поэтому точность представления может страдать, мы будем отнимать степени двойки пока не получим 0 или пока не закончится мантисса.

Отсюда и "уплывание" точности, отсюда же и разделение на float/double, чем больше битов есть для хранения значения, тем более высокую точность можно записать.

Для полноты картины, приведу пару математических выкладок, по только что описанному алгоритму

Алгоритм вычисления значений с плавающей запятой

и по формуле, представленной в самом начале

Формула вычисления значения с плавающей запятой

чтобы можно было самостоятельно посчитать на калькуляторе и убедиться в тождественности выражений. Так, число с плавающей запятой возможно посчитать двумя способами: по приведённой формуле, или последовательно складывая разряды мантиссы умноженные на двойку в степени порядка, уменьшая порядок на каждом шагу.

Может, есть какие-то особенности?

Конечно, куда же без них. Посмотрим на диапазон возможных значений чисел с плавающей запятой и отметим некоторые особенности:

Значения чисел с плавающей запятой

возможен как положительный, так и отрицательный ноль (в целых числах ноль всегда положительный);
есть огромная зона, отмеченная на рисунке, которая являет собой непредставимые числа, слишком большие для хранения внутри такой переменной или настолько маленькие, что мнимая единица в мантиссе отсутствует;
в таком числе можно хранить значения положительной и отрицательной бесконечности;
при работе с такими числами появляется понятие не-числа, при этом важно помнить, что NaN не равен NaN.

LaTeX: базовое форматирование

2022-04-13T06:26:22.907Z

LaTeX используется во всем мире для научных публикаций, документации, книг и во многих других формах публикации. Он не только позволяет создавать корректно оформленные документы, но и позволяет пользователям быстро справляться с сложными аспектами вёрстки текста, такими как ввод математических данных, создание оглавлений, ссылок и библиографий, а также согласованная компоновка текста во всех разделах документа. Благодаря огромному количеству доступных пакетов с открытым исходным кодом (подробнее об этом позже) возможности LaTeX почти безграничны. Эти пакеты позволяют пользователям значительно расширить возможности LaTeX, например создавать сноски, рисовать схемы и диаграммы, создавать таблицы. Также возможно создавать презентации и подключать модули для работы с таблицами, например язык анализа данных R.

Одна из наиболее важных причин по которым люди используют LaTeX, заключается в том, что он отделяет содержимое от стиля. Это означает, что как только вы напишите свой документ, мы с легкостью сможем изменить его внешний вид. Аналогичным образом, вы можете создать один стиль документа который можно использовать для стандартизации внешнего вида множества различных документов.

Первый шаг - создать новый проект LaTeX. Вы можете сделать это на своем компьютере, создав новый файл .tex, или же вы можете начать новый проект в Overleaf (онлайн редактор LaTeX документов. Автор предлагает в первую очередь освоить и использовать именно его).

\documentclass{article}

\begin{document}
First document. This is a simple example, with no 
extra parameters or packages included.
\end{document}

В первой строке кода объявляется тип документа, известный как класс. Класс управляет внешним видом документа. Для разных типов документов потребуются разные классы, т.е. для резюме потребуется не такой класс, как для научной статьи. В данном случае классом является article, статья, самый простой и распространенный класс LaTeX. Принципиальной разницы между простыми текстовыми классами нет, в отчёте добавляется ещё одна ступень иерархии заголовков относительно статьи - часть, а в книге ещё одна ступень относительно отчёта - глава. Соответственно этому незначительно меняются стандартные отступы и колонтитулы, которые в документах, создаваемых не в учебных целях всё равно изменяются на собственные. Принципиально отличается только класс Beamer, позволяющий создавать презентации.

Преамбула документа

В предыдущем примере текст был введен после команды \begin{document}. Все, что находится в файле .tex до этого момента, называется преамбулой. В преамбуле определяется тип документа, язык, пакеты (подробнее об этом позже), и несколько других элементов. Например, обычная преамбула простого документа будет выглядеть следующим образом:

\documentclass[12pt, a4paper]{article}
\usepackage{cmap}
\usepackage[T2A]{fontenc}
\usepackage[utf8]{inputenc}

Или, как мы выяснили в прошлый раз, при использовании более современного компилятора

\documentclass[12pt, a4paper]{article}
\usepackage[russian]{babel}
\babelfont{rm}{PT Astra Serif}
\babelfont{sf}{PT Astra Serif}
\babelfont{tt}{Courier}

Полужирный, курсив и подчеркивание

Очень часто в тексте документа нужно выполнить выделение полужирным, курсивом или подчёркиванием. Эти частые операции осуществляются написанием выделяемой части текста в соответствующем тэге:

Жирный шрифт: \textbf{...}.
Курсив: \textit{...}.
Подчеркивание: \underline{...}.

Добавление изображений

Теперь рассмотрим, как добавлять изображения в документ LaTeX. Ниже приведен пример того, как включить изображение.

\documentclass{article}
\usepackage{graphicx}
\graphicspath{ {images/} }

\begin{document}
The universe is immense and it seems to be homogeneous, in a large scale, everywhere we look at.

\includegraphics{universe}
There's a picture of a galaxy above

LaTeX не может работать с изображениями сам по себе, поэтому вам нужно будет использовать пакет. Помните, мы упоминали пакеты выше, и даже использовали несколько для написания текста кириллицей?
Если взглянуть в мир LaTeX чуть глубже, для пакетов есть онлайн архив CTAN, у каждого пакета есть очень подробная документация, а для пакетов, создающих, например, ГОСТ стили ещё и на русском.
Пакеты можно использовать для изменения внешнего вида вашего документа по умолчанию или для расширения функциональных возможностей. В данном конкретном случае необходимо включить изображение в документ, поэтому следует использовать пакет graphicx. Этот пакет предоставляет команды \includegraphics{...} и \graphicspath{...}. Чтобы использовать пакет, необходимо включить в преамбулу строку \usepackage{graphicx}.

Команда \graphicspath{ {images/} } сообщает LaTeX, что изображения хранятся в папке с именем images в текущем каталоге (относительно файла .tex, в котором ведётся работа).
Команда \includegraphics{universe} - включает изображение в документ. Здесь universe - это имя файла, содержащего изображение без расширения, поэтому universe.png становится universe. Имя файла изображения не должно содержать пробелов или нескольких точек.

Примечание: Если расширение файла опущено, LaTeX попробует выполнить поиск по всем поддерживаемым форматам. Также обычно рекомендуется использовать строчные буквы для расширения файла при загрузке файлов изображений.

Подписи, ярлыки и ссылки

Изображения могут быть подписаны, помечены и снабжены ссылками с функцией figure, как показано ниже:

\begin{figure}[h]
    \centering
    \includegraphics[width=0.25\textwidth]{mesh}
    \caption{a nice plot}
    \label{fig:mesh1}
\end{figure}

As you can see in the figure \ref{fig:mesh1}, the
function grows near 0. Also, in the page \pageref{fig:mesh1}
is the same example.

В примере приведенном выше есть три важные команды:

\caption{a nice plot}
\label{fig:mesh1}
\ref{fig:mesh1}

При размещении изображений в документе LaTeX рекомендуется помещать их в среду figure или аналогичную среду, чтобы LaTeX расположил изображение таким образом, чтобы оно соответствовало остальной части вашего текста. Среды выступают как полноценные и самостоятельные единицы. Сами эти окружения часто располагаются по правилам, а внутри них действуют собственные правила размещения. Например, оператор centering в figure отцентрирует его содержимое, а сама figure будет стремиться расположиться на одной странице, то есть является неразрывной. Так в figure нельзя помещать длинные таблицы, потому что LaTeX не сможет вставить в длинную таблицу разрыв страницы и мы просто-напросто не увидим то, что выходит за пределы листа А4.

Создание списков в LaTeX

Создавать списки в LaTeX очень просто. Вы можете создавать списки, используя различные среды списков. Ещё раз: среды - это разделы нашего документа, которые вы хотите представить иначе, чем остальную часть документа. Они начинаются с \begin{...} и заканчиваются на \end{...}.

Существует два основных типа списков: упорядоченные списки и неупорядоченные списки. Каждый из них будет использовать разную среду.

Неупорядоченные списки

Неупорядоченные списки создаются средой itemize. Каждой записи должна предшествовать управляющая последовательность \item, как показано ниже.

\begin{itemize}
\item The individual entries are indicated with a black dot, a so-called bullet.
\item The text in the entries may be of any length.
\end{itemize}

По-умолчанию отдельные записи обозначаются черной точкой, так называемой маркировкой. Текст в записях может быть любой длины. Чтобы изменить маркер списка необходимо в преамбуле документа обновить значение для команды \item. В примере ниже используется длинное тире, шириной в одну букву M используемого вами шрифта.

\renewcommand\labelitemi{\emdash}

Упорядоченные списки

Упорядоченный список имеет тот же синтаксис в другой среде. Мы создаем упорядоченные списки, используя среду enumerate:

\begin{enumerate}
\item This is the first entry in our list
\item The list numbers increase with each entry we add
\end{enumerate}

Как и в случае с неупорядоченными списками, каждой записи должна предшествовать управляющая последовательность \item, которая автоматически сгенерирует номер, обозначающий элемент. Из-за такой автоматизации удобно перемещать элементы списка между собой, не заботясь о нумерации. Перечисляемые метки состоят из последовательных номеров, начинающихся с единицы. Это поведение также возможно изменить, добавив соответствующую строку в преамбуле, но для примера, изменим перечисляемые метки для одного списка:

\begin{enumerate}[label=\asbuk*),ref=\asbuk*]

Такой набор опций создаст список из меток а) б) в) ....

Вместо выводов

В этой статье я постарался описать самые часто используемые инструменты базового редактирования текста. Для оформления подавляющего большинства текстов этого будет достаточно. Осталось описать таблицы, псевдографику, множественные источники данных и автоматизации, но часто это причисляют к нетривиальным механизмам, поэтому пока возьмём небольшую паузу. Думаю, важно будет сказать, что использование LaTeX - это дело привычки. Например, однажды сформировав преамбулу для своих документов (например, по внутреннему, корпоративному стандарту) перестаёшь думать о стилях и вёрстке, а думаешь уже только о содержательной составляющей.

LaTeX: мотивация.

2022-03-14T11:07:45.898Z

"Даже путь в тысячу ли начинается с первого шага." — Лао-цзы. Глава 64, строка 12 книги Дао дэ цзин

TL;DR.

Устав от необходимости вникать в тонкости вёрстки документов, автор открыл для себя и хочет открыть для других дивный новый мир компьютерной вёрстки документов.

Проблемы

Рано или поздно каждый сталкивается с необходимостью создать текстовый документ, который должен отвечать некоторым требованиям форматирования и/или мультимедийности. У многих людей с созданием таких документов связана значительная часть работы, а для некоторых - это основная деятельность. Я, как и многие другие люди, не задумывался об используемом инструментарии и "как и все" просто открывал первый попавшийся MS Word, MS WordPad, Apple Pages, LibreOffice Writer (давайте я дальше буду их для краткости называть "офисом"), писал то, что мне было нужно, закрывал и забывал.

Всё было хорошо, пока я не обнаружил себя копирующим-вставляющим очередные пять страниц текста в новый файл, чтобы изменить в нём пару-тройку десятков слов. Это привело меня к первой, главной для ленивого человека, проблеме: автоматизация рутинных операций, обозначим её как "проблему номер один".

Смена деятельности на основной работе (необходимость создавать ещё больше документации) показала пример нерадивости некоторых коллег: отправив очередной большой документ, страниц на 400-500, на доработку в ответ я получил этот же самый документ с обновлённой меткой "последних изменений". То есть, чтобы понять, что именно изменилось (или не изменилось), мне пришлось заново вычитывать несколько сотен страниц. Это позволило сформулировать проблему ленивого человека, которую мы можем назвать "проблема номер два": из рук вон плохие или полностью отсутствующие версионирование и контроль контента.

В процессе работы, документ-с-комментариями (тот самый, из предыдущего пункта) разросся до полутора тысяч страниц, а работать над ним начали несколько человек, что помогло сформулировать ещё две проблемы, соответственно, "номер три" и "номер четыре": отсутствие возможности совместной (командной) разработки, чрезвычайно долгое или вовсе невозможное открытие и редактирование больших документов, особенно на "слабых" компьютерах.

Как постскриптум к подразделу "проблем" хочу напомнить о боли, которую испытывали, кажется, все пользователи офиса - попытки переместить вставленное изображение куда-то выше или ниже по тексту мышкой. Передаю привет поехавшим абзацам, картинке, уходящей за пределы страницы и многочасовым попыткам сверстать документ "как задумано".

Поиски решения

Быстрый поиск решений первой проблемы, той, которая про автоматизацию, не увенчался успехом. Были созданы некоторые "эталонные шаблоны", которые открывались, редактировались, "сохранялись как" в новый файл, иногда просто сохранялись и найти человека, который не сохранил себе копию, а вписал данные в шаблон, было невозможно. В общем, автоматизация рутины средствами существующих программ провалилась.

Быстрый поиск решения проблемы контроля контента не решился, хотя в новых версиях офисных пакетов, кажется, появился функционал версионирования, но работает он не слишком очевидно, и требует включения в каждом конкретном документе. Но поиск привёл к необходимости оставлять комментарии по тексту, и это даже показалось сравнительно удобным, хотя, как оказалось, не все умеют включать отображение комментариев и использовать их по назначению.

Решить проблему командной работы не удалось вовсе. Даже гуру офисной работы, создавая документ признают, что просто копипастят фрагменты документа в один, и тратят несколько часов на увлекательное приведение к единому формату, например, по ГОСТ.

К слову о попытках решения обозначенных четырёх проблем нельзя не упомянуть современные легковесные форматы текста, вроде Markdown, которые позволяют с минимальными усилиями создавать аккуратные одинаково выглядящие документы, заметки, инструкции и описания. И, кажется, .md всем хорош, но только лишь для "внутреннего использования", то есть, в нём довольно затруднительно сменить шрифт, создать, например, оглавление, создать документ, разбитый на страницы, изменить колонтитулы, отступы, пронумеровать заголовки, и многое другое.

Возможное решение

Устав от попыток решить эти скучные проблемы я решил подумать головой. Этот непривычный процесс привёл к поразительному результату: мои проблемы возникали в разное время не у меня одного, и люди уже давно придумали решение. Конечно, решение не без оговорок, именно поэтому я озаглавил его как возможное. Системы компьютерной вёрстки.

Согласно википедии, LaTeX — наиболее популярный набор расширений системы компьютерной вёрстки TeX, который облегчает набор сложных документов. Важно заметить, что ни один из макропакетов для TeX’а не может расширить возможностей TeX (всё, что можно сделать в LaTeX’е, можно сделать и в TeX’е без расширений), но, благодаря различным упрощениям, использование макропакетов зачастую позволяет избежать весьма изощрённого программирования. Пакет позволяет автоматизировать многие задачи набора текста и подготовки статей, включая набор текста на нескольких языках, нумерацию разделов и формул, перекрёстные ссылки, размещение иллюстраций и таблиц на странице, ведение библиографии и др. Кроме базового набора существует множество пакетов расширения LaTeX. Общий внешний вид документа в LaTeX определяется стилевым файлом. Существует несколько стандартных стилевых файлов для статей, книг, писем и т. д., кроме того, многие издательства и журналы предоставляют свои собственные стилевые файлы, что позволяет быстро оформить публикацию, соответствующую стандартам издания.

Выражаясь проще, это некоторый набор специальных команд, написанных прямо посреди обычного текста (того, который можно написать прямо в блокноте и сохранить с расширением .txt) и, не особо думая о вёрстке, получить в результате ровный, опрятный, строго шаблонизированный документ.

В процессе работы с LaTeX нам всё равно придётся ввести понятие компиляции, поэтому предлагаю не откладывать в долгий ящик. Компиляция - это создание некоторого "фиксированного образа" (запускаемый файл программы для программирования, готовый документ для LaTeX, набор песен на компакт-диске), доступного только для чтения, из некоторого "исходного текста". То есть, это подход, отличающийся от привычного в офисе - писать прямо в документе, который потом и отправится на печать. LaTeX компилирует документы по строго определённым правилам, что порождает как плюсы, так и минусы. Самый большой плюс в том, что нам (почти) не нужно думать о вёрстке (отступах, размерах, стилях, шрифтах), а самый большой минус в том, что мы не видим результат нашей работы сию секунду, поскольку то, что мы пишем - не скомпилировано.

Поскольку это работа с простым текстом (а не с хорошо завуалированным архивом и xml документом, как это происходит в случае с офисом), то сразу отпадает проблема версионирования, ведь любой простой текст можно отслеживать в git. Проблема открытия гигантских документов тоже отходит на второй план, прямо сейчас я пишу эту заметку в текстовом файле, который использую как личный цифровой блокнот, который насчитывает более двадцати тысяч строк текста. Как решать первую и третью проблемы (автоматизация и командная работа) попробуем поговорить в следующей статье, поскольку это выходит за пределы рассуждений о мотивации.

Первый документ

Как и везде, в изучении нового инструмента есть два пути, сложный и простой. Мы, для начала, пойдём простым. Только лишь потому, что в LaTeX и без того достаточно много вещей, которые могут отпугнуть простого пользователя, не будем добавлять к ним ещё и вопросы настроек инструментария. Спасибо создателям сервиса https://www.overleaf.com/ за их труд, они действительно, как это заявлено на стартовой странице, LaTeX,Evolved: The easy to use, online, collaborative LaTeX editor. То есть, улучшили процесс редактирования LaTeX документов настолько, насколько это вообще было возможно. Пройдя несложную регистрацию, мы видим (пока что) пустой список наших проектов. Создадим новый проект и Overleaf создаст для нас шаблон пустого документа, в котором будут прописаны минималистичные настройки. То есть, документ уже как-то выглядит и если к нему не предъявляются дополнительные требования, может быть отредактирован и отправлен куда нужно, для этого мы нажимаем кнопку "Download PDF" и наслаждаемся полученным документом.

Но внимательный читатель (привет тебе, зануда, на таких как ты держится земля), который сразу пошёл проверять, так ли это, заметил проблему. Не отображается кириллица. Всё в документе есть, а кириллических символов нет. Раз и навсегда решим эту проблему в два шага:
1. Menu - Settings - Compiler - XeLaTeX;
2. вторую строку \usepackage[utf8]{inputenc} нужно стереть и заменить на четыре:

\usepackage[russian]{babel}
\babelfont{rm}{PT Astra Serif}
\babelfont{sf}{PT Astra Serif}
\babelfont{tt}{Courier}

где вместо PT Astra Serif и Courier нужно вставить названия любых шрифтов, которые Вы считаете хорошими. Мелким шрифтом, стоит оговорить, что всеми любимый Times New Roman является запрещённым на территории России шрифтом, а Astra Serif является его легальным бесплатным аналогом. Но, если очень сильно хочется именно его, то можно решить проблему (в том числе) так:

\usepackage{fontspec} 
\setmainfont{Times New Roman}

Эти строки заменяют те сложные четыре из второго пункта. Решать задачи можно по-разному, и это прекрасно.

Что дальше?

Простейший документ получен. Неплохой результат. Кстати, внимательный читатель мог заметить, что мы использовали некоторую "управляющую" конструкцию \usepackage, которая добавила нашему документу функциональности, например, возможность менять шрифт со стандартного. Именно такие управляющие конструкции будут нашими лучшими друзьями при дальнейшем, в том числе сложном, редактировании документов.

Базовые принципы

2021-01-03T19:26:26.493Z

(в основном, программирования)

Собеседования. Все мы, так или иначе, рано или поздно их проходим. Сегодня я хочу поговорить о часто задаваемых вопросах на собеседованиях. И технических мы коснёмся только в самом конце нашей беседы. Я убеждён, что все принципы, описанные для использования в сфере информационных технологиях подходят и для обычной, повседневной, жизни. Я буду называть принципы и примеры, а додумать применимость в жизни я оставлю читателю.

DRY

Don't repeat yourself. Акроним dry (англ. сухой, чистый). Не повторяйся. Любой код, который программист вынужден повторять можно убрать в цикл, метод, класс, подпрограмму, модуль, сервис. Если в Вашей программе есть повторяющийся (скопипастченный) код - это не очень хорошая программа, потому что если и когда Вам нужно будет её исправлять - Вы потратите вагон времени только на поиск всех мест, содержащих нужную копипасту. Программы и компьютеры, их же придумали как раз для того, чтобы не нужно было самому выполнять повторяющиеся действия. Поэтому, не повторяй себя. Двигайтесь вперёд. Антагонист этого принципа - WET. Write everything twice. Акроним wet (англ. влажный). Пиши всё дважды. Экономьте собственное время, не пишите по два раза.

KISS

Keep it simple, stupid. Сохрани это простым, до глупости. Это не призыв быть глупым, как могло показаться на первый взгляд. Это призыв оставаться понятным и простым в рассуждениях, объяснениях и описании кода. Никто не любит тех, кто умничает по поводу и без него. Если есть возможность решить задачу просто и быстро - нужно воспользоваться ей. Если же совсем никак не получается без сложного и неочевидного решения: обильно прокомментируйте его. Известно, что если вы не можете объяснить своё занятие или свои действия пятилетнему - вы слишком мудрите. Или занимаетесь ерундой, выбирайте сами. Всегда думайте, что ваш код будет читать живой человек, который не может залезть к вам в голову и магически понять "что имел ввиду автор". Да и старую поговорку "будь проще и люди к тебе потянутся" тоже никто пока что не отменил.

YAGNI

You ain't gonna need it. Вам это не понадобится. Здесь возможны две трактовки, но обе сводятся к одному: не делай лишнего. Да, всегда нужно думать немного наперёд, бесспорно. Но всегда эта мысль должна опираться на здравый смысл: настанет ли момент когда это может пригодиться. И да, всегда нужно стараться сделать чуть больше и чуть лучше, чем требуется, но нужно думать: не затрачу ли я на это вообще все свои ресурсы без остатка? Поэтому: делайте лучше, делайте больше, делайте наперёд, но только если это для вас ничего не стоит. Иначе, поберегите силы.

SOLID

Ну и немного действительно полезной информации, такое любят спрашивать на джуниорских собеседованиях. Это акроним, solid - надёжный, цельный. Состоит этот акроним из целых пяти понятий, каждое из которых так или иначе делает ваш код лучше, надёжнее, понятнее.

Single responsibility principle - принцип единственной ответственности, атомарности. Любой объект, будь то класс, экземпляр или функция должны выполнять одно дело, но делать это полностью и хорошо. Если Ваш объект занимается больше, чем одним делом - это плохой объект. Этот принцип можно перефразировать пословицей "за двумя зайцами погонишься - ни одного не поймаешь".

Open/close principle - принцип открытости/закрытости, описываемые Вами объекты (да, тут про объектно-ориентированное программирование) должны быть открыты для расширения и закрыты для модификации. То есть поведение объекта должно быть максимально инкапсулировано, но чем больше у объекта потенциал к расширению (применению наследования и полиморфизма) тем лучше. Это позволяет, помимо прочего, следовать принципу DRY.

Liskov substitution principle - Принцип подстановки Барбары Лисков. Используемые и описываемые вами объекты должны быть заменяемы на свои подтипы без изменения правильности работы. Этот принцип тесно связан с предыдущим и согласно ему котики и пёсики должны уметь делать всё, что умеет делать животное, но не обязательно котик должен уметь делать то, что умеет пёсик. Наследование и полиморфизм.

Interface segregation - Принцип разделения интерфейсов. Много разных интерфейсов всегда лучше одного общего. Звучит знакомо? Да, конечно, это же Single responsibility, естественно, это касается и интерфейсов и сложного ООП. В конце концов, Вам жалко что ли насоздавать интерфейсов на каждый чих? Это гораздо более гибко, чем иметь один God-Interface через который будут работать вообще все объекты в программе.

Dependency inversion - Инверсия зависимостей. Все зависимости должны быть абстрактны. Не стоит вписывать в свою программу зависимость от какого-то конкретного класса, если есть возможность зависеть от интерфейса. Ваш код таким образом становится гораздо более расширяем и его можно гораздо проще переиспользовать в других проектах, поскольку у Вас не будет зависимостей от конкретных классов, и вы не будете связаны наследованием.

Описанные принципы, несмотря на свою кажущуюся технологичность, подходят и для жизни:

S - не пытайтесь делать несколько дел одновременно;
O - постарайтесь сделать так, чтобы не пришлось переделывать;
L - используйте заменяемые объекты (чтобы сидеть, используйте стул, а не шкаф);
I - лучше использовать несколько простых инструментов, чем сто-в-одном;
D - делайте так, чтобы результатом вашего труда мог воспользоваться кто угодно, а вы не зависели от специфичных решений, больше абстрагируйте.

И напоследок

Принцип, который чаще всего помогает в работе лично мне, потому я дал себе труд его сформулировать: При работе всегда надо стараться пользоваться не новыми технологиями, а головой.(с) Иван Овчинников, 2018г.

Двоичные операции

2020-12-11T21:07:56.796Z

В современных реалиях мегамощных компьютеров (давайте я буду называть их исполнителями, потому что имеются ввиду вообще все устройства, способные выполнять программу, а это и компьютеры и ноутбуки и телефоны и прочие содержащие электронную слаботочную начинку утюги) вряд ли кто-то задумывается об оптимизации скорости выполнения программы или экономии занимаемой памяти. Но всё меняется, когда программист впервые принимает сложное решение: запрограммировать микроконтроллер или другой «интернет вещей». Там в вашем распоряжении жалкие пара мегабайт памяти, если очень повезёт, в которые нужно не только как-то впихнуть текст программы и исполняемый бинарный код, но и какие-то промежуточные, пользовательские и другие данные, буферы обмена и обработки. Другая ситуация, в которой нужно начинать «думать о занимаемом пространстве» это разработка протоколов передачи данных, чтобы протокол был быстрый, не гонял по сети сумасшедшие килобайты данных и быстро преобразовывался (сериализовался/десериализовался). На помощь приходит натуральная (если можно так выразиться) для информатики система счисления, двоичная. И правда, если нам нужно передать по сети, например, поле для игры в морской бой, размером 10х10, каждая клетка которого может находиться как минимум в трёх состояниях (закрыта, пуста, занята) нам для такой передачи явно будет недостаточно булева типа, но и самый маленький тип в java - byte с его диапазоном -128...127 будет чрезвычайно избыточен. Если не использовать никаких оптимизаций то одна посылка будет занимать сто байт. Мы же можем придумать такой протокол, который сможет уместить поле 10х10 в 200 бит, то есть в 25 байт. В четыре раза компактнее, а значит и быстрее. Как это сделать?

Лирическое отступление:

Системы счисления

Числа не существуют сами по себе, они связаны определёнными в математической науке законами и полностью подчиняются ей. Программирование, как один из аспектов жизни тоже полностью подчинено математике (называется сложным словосочетанием «математическая доказательность»), но не такой математике, которой пугают людей, а базовой, на уровне «прочитать число», «записать число», произвести сложение, вычитание, умножение. Запись чисел осуществляется поразрядно, то есть одно число может содержать несколько цифр, стоящих друг за другом. Разряды в записи чисел увеличивают свой вес справа налево, то есть самая правая цифра - самая маленькая. В любой системе счисления более значимый разряд всегда находится левее и увеличивается на единицу, если менее значимый разряд «переполняется». Мы можем это увидеть в привычной нам десятичной системе счисления, когда разряд единиц достигает цифры девять, на единицу увеличивается разряд десятков, а разряд единиц «сбрасывается в ноль». Просто потому, что такое основание, можно сказать, что «так исторически сложилось» или «других цифр не придумали» (кстати, для шестнадцатеричной системы счисления, в итоге придумали)

Двоичная система счисления

Представляет особенный интерес для области информационных технологий, поскольку вся электроника работает по принципу «есть напряжение или нет напряжения», единица или ноль. Все числа из любых систем счисления в результате преобразуются в двоичную и представляются в виде набора единиц и нулей. Так для записи десятичного числа 116 используется двоичная запись 1110100. Преобразование из системы счисления с бОльшим основанием в систему счисления с меньшим основанием производится последовательным делением исходного числа на основание системы счисления и записи остатков такого деления в младшие разряды. Например:

116/2= 58(0) /2= 29(0) /2= 14(1) /2= 7(0) /2= 3(1) /2= 1(1) /2= 1< 2

В этом примере полученные остатки от деления записаны в скобках и можно обратить внимание на то, что они полностью повторяют запись числа 116 показанную ранее в зеркальном отражении. Обратное преобразование - это последовательное умножение разрядов числа на величину каждого разряда с их аккумулированием к общему результату:

1110100= 0*1+ 0*2+ 1*4+ 0*8+ 1*16+ 1*32+ 1*64= 4+ 16+ 32+ 64= 116

В программах двоичный числовой литерал записывается с префиксом 0b,то есть для нашего примера 0b1110100. Поскольку двоичная система счисления является основной для компьютерной техники, помнить, например, значения степеней двойки - обычно, хорошее подспорье в работе.

Вернёмся к нашему полю 10х10.

Представления чисел.

Для того, чтобы записать три состояния нам нужны двоичные числа 0(00), 1(01) и 2(10). Что, очевидно, занимает два разряда двоичной записи и даже ещё остаётся место для четвёртого (третьего) состояния 11. То есть четыре ячейки поля могут быть записаны в 2х4 разрядах, в одном стандартном восьмибитном байте. Давайте разбираться, как это сделать, и что нам это даёт. Итак мы можем равноправно считать как в десятичной, так и в двоичной системах счисления, значение числа останется прежним, как его ни записывай. Поэтому мы можем сказать, что один байт, состоящий из восьми бит может сохранить для нас четыре клетки нашего поля по четыре состояния каждая, для этого его надо разделить на пары битов 00_00_00_00. Каждая пара будет в состоянии сохранить значение 0(00), 1(01), 2(10) или 3(11). В этом случае нам становится неудобно записывать наши данные в десятичной системе счисления, ведь не сразу очевидно, какое именно число скрывается за двоичным кодом, например, 01_10_00_10. Далее, для удобства восприятия я буду разделять запись байта на такие пары.

Маски и битовые сдвиги

Чтобы записать число в переменную мы используем привычный оператор присваивания и пишем byte a = 3; Исполнитель в этом случае превратит некоторую область памяти из 00_00_00_00 в 00_00_00_11. Мы можем попросить исполнителя сместить записанные биты влево или вправо на нужное количество разрядов используя оператор << или >> соответственно. Например, byte a = 3 << 2; В этом случае переменная будет иметь вид 00_00_11_00, что равно двенадцати. Внимательный читатель мог заметить, что сдвинуть на 2 это тоже самое, что умножить на 4. Если развивать эту мысль, то можно однозначно сказать, что сдвиг числа влево на N разрядов эквивалентен умножению этого числа на 2 в степени N. Можем ли мы как-то удобно получить нужное значение из конкретных битов без необходимости двигать их туда-обратно? Конечно, для этого придумали маски.

Например, я хочу узнать, какое значение имеет самый младший бит (признак чётности) в записанном значении byte a = 3; Я применяю к этому числу так называемую маску: говорю, что остальные биты мне не важны, и я хочу увидеть состояние именно этого. На помощь спешит операция побитового И. В некоторых источниках её ещё называют арифметическим И. Записывается она в виде амперсанда (&) и возвращает для разряда единицу только если в обоих операндах в соответствующих разрядах единицы. То есть:

3(00_00_00_11) & 1(00_00_00_01) = 1(00_00_00_01); 
4(00_00_01_00) & 1(00_00_00_01) = 0(00_00_00_00).

Как видно, мы получили в результате цифру, обозначающую чётность исходного числа. Накладывать такие маски можно не только на один разряд, но на любое их количество. Маска для двух разрядов это &3, для трёх &7, для четырёх &15 и так далее &31, &63. Эти числа неожиданно сильно напоминают степени двойки, не правда ли? Маски также можно сдвигать относительно проверяемого числа, например, проверить старшие два разряда нашего замученного байта можно так: byte result = a & (3 << 6); здесь мы двухбитную маску 3(11) сдвигаем на шесть разрядов (11_00_00_00) и накладываем на число a (xx_xx_xx_xx & 11_00_00_00) таким образом нам вернётся состояния именно этих двух битов, остальные биты этого числа мы игнорируем (маскируем) они станут нулями. И нам, кстати, совершенно нет дела до того, какое будет у байта десятичное представление. А чтобы получить не просто значение маскированной переменной, а именно этих двух старших битов, нужно полученное маскированное значение сдвинуть обратно вправо на количество битов, на которое изначально сдвигали влево. То есть если мы изначально xx сдвинули на шесть разрядов влево, теперь маскированное значение нужно сдвинуть на шесть разрядов вправо.

Заключение

Тема битовых операций постепенно теряет свою актуальность в связи с развитием технологий, скоростей, объёмов. Скорее всего, битовые операции в ближайшем будущем перейдут в разряд узкоспециальных знаний и будут применяться только при программировании микроконтроллеров. И правда, зачем такие сложные вещи в условном JavaScript/HTML5, где основная задача - это быстро и красиво для разработчика и пользователя, и можно не особо считать потраченные килобайты.

Постскриптум

N << K = N * 2 в степени K

N >> K = N / 2 в степени K

x & y = битовая. 1 если оба x == 1 и y == 1

X && Y = литеральная.

x | y = битовая. 1 если хотя бы один из x == 1 или y == 1

X || Y = литеральная

x ^ y = битовая. 1 если x отличается от y

~x = битовая. 1 если x == 0

!X = литеральная

Литеральные операции применяются ко всему числовому литералу целиком, а не к каждому отдельному биту. Здесь особенность в том, как язык программирования интерпретирует числа. В Java, например, в таких операциях может участвовать только тип boolean, а C++ воспринимает любой ненулевой числовой литерал как истину, а нулевой, соответственно, как ложь. Логика формирования значения при этом остаётся такой же, как и при битовых операциях.

Форматированный вывод

2020-12-07T12:43:40.435Z

Подавляющее большинство мануалов по тем или иным языкам программирования показывают прекрасный пример того, как начинающему программисту написать свой первый "Hello, world!" и это прекрасно! Давайте разбираться, почему этого недостаточно и как сделать жизнь программиста чуть лучше. Да, по форматированному выводу написано также огромное количество мануалов, в том числе в стандартных документациях к языкам, но почему бы не сделать попытку отказаться от казённого языка больших компаний и не рассказать своими словами?

Немного истории

Современные языки программирования, так или иначе, но берут своё начало в C.

...

Так, мы подождали, когда нас покинут эксперты в области истории программирования и можем спокойно продолжать. Подавляющее большинство так называемых "языков высокого уровня" содержат отличную стандартную библиотеку функций (классов и методов), в которой описана функция print() она обычно либо лежит в системном классе, либо в другом очень удобном и доступном месте. Все люди ей радостно пользуются, и если нужно, например, собрать строчку из нескольких составляющих просто применяют конкатенацию строк, получая что-то вроде print("Hello, I'm " + "Ivan " + 35 + " years of age");. Всё очень хорошо и понятно. но можно лучше. Разработчики языков программирования придумали, как избавиться от конкатенации и удобно форматировать строки. Нужно написать параметризированный шаблон и подставлять в него значения. Всего навсего.

Понятие форматирования

Всё началось в K&R C, где функция print(); не была описана вовсе. Это было для меня камнем преткновения изучения C в школе, где на уроках информатики нам преподавали QBasic. Я использовал директиву print(); а компилятор упорно утверждал, что не знает такой. Удивительно, что простой вывод осуществлялся функцией printf(); что расшифровывалось как print formatted. Форматированный вывод подразумевал как раз создание шаблона строки и заполнения его параметрами, хотя и простой "Hello, world" с его помощью вывести можно. Что представляет собой форматирование? Это отличается от того, к чему мы привыкли при форматировании текста в HTML или MS Word, где под этим словом подразумевается создание отступов, интервалов и прочих украшательств. В программировании форматирование - это создание таких мест в строке, которые будут заполнены значениями, так или иначе переданными шаблону. Места, которые будут заполнены значениями отмечаются в шаблоне специальной последовательностью, которая называется placeholder (англ. - держатель места, заполнитель). То есть, если мы опишем вызов шаблона "Hello, %s" и передадим в него литерал "world" вся строка в шаблоне выведется "как есть", а заполнитель заменится на переданный литерал. Заполнитель представляет собой символ % и некоторую последовательность, означающую, собственно, формат принимаемого в заполнитель значения. Самые популярные заполнители - это:
- %s - string, обычный строковый литерал. Представляется "как есть", не дополняется никакими символами и не обрезается.
- %d, %i - decimal, integer - целое число в десятичной системе счисления. Разницы в использовании %d и %i нет
- %x, %X - hexadecimal - целое число в шестнадцатиричном представлении. Разница между %x и %X в том, что в итоговой строке будут использованы строчные или заглавные буквы A-F для представления чисел 10-15
- %f - float - числа с плавающей точкой (дробные числа)
- %c - character - символ.
- %% - собственно, символ процента. Поскольку с него начинается специальная последовательность, чтобы вывести символ "как есть" нужно было положить его внутрь последовательности. Выкрутились.

Параметры, передаваемые заполнителям, передаются в ту же функцию форматирования после строки шаблона через запятую (функции форматирования всегда принимают аргумент переменной длины). Параметры всегда присваиваются заполнителям в том порядке, в котором переданы, то есть первый заполнитель всегда держит место для первого параметра, второй для второго и так далее.

Некоторые заполнители могут дополняться параметрами, так, например, %5d будет означать, что переданное целое число будет помещено в пространство из не менее, чем пяти символов (слева будут дописаны пробелы, если число занимает меньше символов). Используя же %05d мы будем минимальное выделенное пространство заполнять не пробелами, а нулями. Или, к примеру, в случае %.2f мы указываем, что дробную часть числа при отображении следует обрезать до двух символов, и число 1.23456 будет отображено как 1.23.

C/C++

Функция printf(); это весьма удобная альтернатива простому выводу в поток вывода в C++. Оператор std::cout не предоставляет возможности к форматированию строк и поэтому, несмотря на свою популярность, не может считаться равноценной заменой классическому printf(); Более того в языке присутствует функция sprintf(); позволяющая осуществлять форматированный вывод не в консоль, но в другой строковый литерал.

char fmt[20];
sprintf(fmt, "shift |%%%dd|, 7);
// no output, but fmt == "shift |%7d|"
printf(fmt, 10);
printf("preformatted with zeros %07d", 10);
// shift |     10|
// preformatted with zeros 0000010

Java

В Java классические форматтеры представлены методами System.out.printf(); (а если быть совсем точным, то PrintStream#printf();) и String#format(); первый осуществляет вывод форматированной строки в поток, второй в строку.

System.out.printf("%s loves string formatting\n", "Everyone");
System.out.println(String.format("Sadly, %.2f%% of programmers use it", 50f));
// Everyone loves string formatting
// Sadly, 50.00% of programmers use it

Python

Здесь форматирование осуществляется всегда для строки и может использоваться внутри функции print(), например, для заполнения значением конкретной переменной

customstring = "String formatting"
print(f"{customstring} is powerful")
# String formatting is powerful

или близким к классическому способом

print("Machine learning provides {} the ability to learn {}".format("systems", "automatically"))
# Machine learning provides systems the ability to learn automatically

Вообще, python в части форматирования строк "пошёл" дальше всех, потому что предоставляет механизмы для именованного заполнения, повторного заполнения держателей и использования.

print("{2} has a friend called {0} and a sister called {1}". format("Betty", "Linda", "Daisy"))
# Daisy has a friend called Betty and a sister called Linda

tool="Unsupervised algorithms"
goal="patterns"
print("{title} try to find {aim} in the dataset".format(title=tool, aim=goal))
# Unsupervised algorithms try to find patterns in the dataset

Выводы

Естественно, каждый может найти как десяток доводов продолжать использовать форматирование строк, так и десяток доводов продолжать их не использовать. В этой статье я постарался ответить на вопрос "а что это у Вас за странный вызов на печать такой", а не дать читателю завет "всегда пользуйся только вот этим". Поиск доводов "за" и "против" автор всегда оставляет читателю.

Ресурсы, чтобы "набить руку"

2020-11-29T20:25:06.237Z

Естественно, список не полон и состоит только из тех ресурсов, которые я в разное время посещал лично, оценочная сложность задач также весьма субъективна (по пятибалльной шкале). Данная статья ни в коем случае не является рекламой ни одного из нижеперечисленных ресурсов и содержит только моё личное субъективное мнение. Список ниже создан исключительно с целью ответа на один из самых часто задаваемых студентами вопросов: есть ли какой то хороший ресурс, где можно попрактиковаться в решении простых и не очень задач.

https://codingbat.com/java
Визуально - не самый красивый сайт, но очень хорошо показывает, какие тесты прошёл Ваш код, а какие нет, что позволяет сориентироваться, в каком направлении думать дальше. Лучшая подборка простейших задач.
Язык интерфейса: только английский
Задачи: Java, Python
Сложность задач: 0 - 4
https://hackerrank.com
Портал, который позиционирует себя как объединяющий компании и исполнителей на основе решения проблем в разных областях знаний. Лучшая подборка задач на алгоритмы и математику.
Язык интерфейса: пишет, что есть русский, но мне не удалось включить
Задачи: Algorithms, Data Structures, Mathematics, C, C++, Java, Python, Ruby, Linux Shell, Functional Programming, AI, SQL, Databases, Regex
Сложность задач: 1 - 4
https://leetcode.com
На мой взгляд немного сложноватая навигация, но симпатично сделанный портал, нацеленный на обучение. Хорошие фильтры для задач, но даже с применением фильтров - задачи не отсортированы по нарастанию сложности. Есть подсказки и секция "похожие вопросы".
Язык интерфейса: не нашёл, где можно поменять
Задачи: C, C++, C#, Java, Python, Python3, JavaScript, Ruby, Swift, Go, Scala, Kotlin, Rust, PHP
Сложность задач: 1 - 5
https://www.codewars.com
Хорошая навигация и усложнение задач по мере прохождения. После решения показывает не только правильный вариант, но и то, как решили другие участники. Лучший редактор кода.
Язык интерфейса: только английский
Задачи: C, C++, C#, Go, Haskell, Java, JavaScript, PHP, Python, Ruby, Rust, Shell, SQL, Swift и ОЧЕНЬ много других, в том числе экзотических, вроде Brainfuck
Сложность задач: 1 - 5
https://www.codingame.com
Пожалуй, самый красивый портал из этого списка. И с самой интересной идеей. Идеально подойдёт тем, кто хочет дальше писать игры. Все задачи завязаны на игровой процесс и шикарно визуализированы.
Язык интерфейса: только английский
Задачи: C, C++, C#, Java, Python3, JavaScript, Bash, Ruby, Swift, Go, Groovy, Scala, Perl
Сложность задач: 2 - 5

От пустого места до пулл-реквеста 2.0

2020-11-29T20:03:50.838Z

Или повесть о настоящем терминале

В продолжение предыдущей статьи о Git, которая по объективным причинам может понравиться не всем. В этом кратком руководстве не будет ничего о теории git, о состояниях файлов и прочей, без сомнения полезной для дальнейшей работы информации. Пошаговая инструкция по внесению правок в проект и предложению своих изменений к ревью, посредством механизма pull-request. С небольшими комментариями к каждому шагу.

Естественно, что любой графический клиент для git - это ни что иное, как набор нарисованных кнопок и полей, выполняющих те или иные терминальные команды приложения git. Также естественно, что зачастую есть необходимость работать с системами контроля версий не только в удобном графическом интерфейсе, но и в терминале, например, на серверах, где разворачивается инфраструктура или приложение. Помимо этого в терминале, естественно, можно осуществлять и разработку приложения.

О том, какие команды нужно выполнить, чтобы начать разрабатывать приложение в безоконной среде и поговорим. Сразу оговорюсь, что в треугольных скобках будет указан аргумент, или часть аргумента, который нужно изменить, чтобы инструкция подходила именно для Вас, например, если написано, что нужно выполнить git commit -m "<your-comment>", то нужно будет выполнить в терминале команду git с аргументом commit и ключом -m после которого в кавычках нужно будет написать Ваш комментарий. Итак, к делу, по пунктам:

Создаём новый проект, или берём существующий, который нужно версионировать. В терминале в папку проекта можно перейти, выполнив команду cd <absolute-path-to-project-directory>, где абсолютный - означает путь от корня файловой системы
Инициализируем в папке новый локальный гит репозиторий командой git init
Добавляем в папку проекта новый файл .gitignore (на UNIX-подобных операционных системах, командой touch .gitignore) и открываем его на редактирование любым текстовым редактором (например, nano .gitignore)
В файл игнорирования нужно вписать все файлы и папки, которые не должны попасть во внешний (удалённый) репозиторий. Их нужно перечислить на отдельных строках. Например, для проекта, написанного в IntelliJ IDEA это должны быть папки .idea/ и out/ а также файл проекта *.imlи таким образом в файле .gitignore можно быть три строки. Сохраняем файл игнорирования.
На сайте github.com создаём новый репозиторий. Это не повторение уже проделанной работы, а создание именованного места хранения Вашего репозитория. Важно помнить, что удалённый репозиторий, созданный на Github'e всегда следует считать основным. После создания у этого репозитория появится свой адрес вида https://github.com/<your-account-name>/<your-repository-name>.git именно этот адрес нам понадобится для дальнейшей работы, скопируем его в буфер обмена.
Нам необходимо добавить в наш локальный репозиторий информацию о том, что его копия будет храниться удалённо, для этого нужно выполнить команду git remote add origin <remote-repository-address> которая добавит удалённый репозиторий под именем origin. Удалённых копий репозитория может быть несколько, главное, чтобы их имена не повторялись.
Мы находимся в локальной ветке master и нам необходимо зафиксировать (сделать коммит) все текущие изменения (те, что уже были в папке на момент инициализации репозитория). Для этого нужно выполнить две команды
git add . git commit -a -m "initial commit"
Особенное внимание следует обратить на то, что в первой команде на конце стоит точка, и это означает, что нужно добавить к версионированию вообще все файлы (кроме игнорируемых) из текущей директории и всех её поддиректорий. Вторая команда может содержать любой текст в сообщении коммита, но обычно пишут, что это начальный, инициализирующий коммит.
Для отправки локального репозитория в удалённый (создания общедоступной копии) необходимо выполнить команду git push -u origin master. То есть указать действие, куда и что нужно "запушить". Ключ -u означает, что в удалённом репозитории на момент выполнения команды push нет ветки с названием master, и мы хотим не только её создать, но и явно указать, что это полная копия нашей локальной ветки master. Установить связь этих веток.
Мы готовы вносить правки. Это принято делать в отдельных ветках, чтобы ненароком не сломать ничего в основной (мастер) ветке. Чтобы создать ветку и переключиться в неё нужно выполнить команды
git branch <branch-name> git checkout <branch-name>
Для навигации по веткам можно использовать git branch -a - команду, которая выведет на экран список всех существующих локально веток проекта, и git checkout <branch-name> - команду, которая переключает ветки.
Здесь, в новой ветке, можно вносить правки в проект без опасения нанести вред основному проекту. Важно помнить, что пока пользователь не зафиксирует свои изменения - они не появятся в git, и пока пользователь сам, явно, ничего из git не удалит - оно никуда не пропадёт. Чем чаще мы будем делать фиксации (коммиты) при работе - тем лучше, таким образом мы сможем точнее отследить момент, например, когда всё перестало работать или сможем случайно удалить меньшее количество данных.
После внесения правок в проект, мы готовы сливать изменения из текущей ветки с основной веткой проекта. В простых проектах, которые обычно пишутся "для себя" это делается командой git merge с указанием веток, которые необходимо слить. В нашем случае, мы хотим, чтобы слияние произошло после ревью изменений другим человеком, для этого нужно опубликовать внесённые изменения. Это делается уже знакомой нам командой git push -u origin <your-branch-name>
На сайте github.com создаём новый pull-request для нашего репозитория. В нём указываем источник изменений - нашу ветку, и назначение изменений - ветку master. В создаваемом запросе на слияние появится несколько вкладок, демонстрирующих какие именно изменения предлагается внести, сколько коммитов понадобилось для написания этих правок и так далее. С точки зрения ревью наиболее интересная вкладка Files, на ней отображаются конкретные изменения конкретных файлов с возможностью комментирования каждой строки.
Важно помнить, что запросы на слияние создаются для веток, а не для конкретных коммитов, поэтому для внесения дополнительных правок после ревью можно осуществлять в уже существующей ветке, и эти правки будут сразу видны в пулл-реквесте. Но у этой особенности есть и обратная сторона - если закрыть пулл-реквест, но не слить ветки проекта - следующий запрос на слияние будет содержать правки всех предыдущих. Поэтому, по завершении работы над веткой, её нужно слить с основной веткой проекта (github позволяет сделать это нажатием кнопки merge) и удалить локально. Новые правки должны вноситься только в новой ветке, см. п. 9.
Для того, чтобы обновить состояние локального репозитория необходимо выполнить команду git pull -a которая скачает из удалённого репозитория текущую версию проекта. Ключ -а означает, что нужно скачать все ветки.
Если по какой то причине локальная ветка с изменениями не слилась с основной веткой репозитория, следует удостовериться, что Вы находитесь в ветке master, и выполнить команду git merge <your-branch-name>. Если все предыдущие пункты были выполнены именно так, как описаны, конфликтов слияния возникнуть не должно

Как мог заметить внимательный читатель, мы поговорили не только о запросах на слияние, но и том, что делать после того, как запрос был удовлетворён (или отклонён). Спасибо за внимание.