Правила нашего процесса разработки

Для того, чтобы сделать наш процесс разработки более управляемым и последовательным, мы следуем некоторым правилам, перечисленным ниже. Некоторые из них — просто соблюдение традиций мира СПО, но другие на самом деле нужны, чтобы избежать недопонимания и введение в заблуждение других участников проекта. Мы будем очень благодарны, если вы также будете соблюдать эти правила, поскольку это, действительно, очень экономит время.

Тем не менее, эти правила являются только рекомендацией и не могут служить основанием для отклонения чего-либо вклада в наш проект.

  1. В репозиториях Git, за исключением системнозависимой части для Microsoft Windows, не должно быть бинарных файлов и служебных файлов различных IDE.

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

  3. Фигурные скобки нужно ставить на отдельных строках (при редактировании кода при помощи речевого синтезатора это ускоряет работу).

  4. Если входные данные в некоторой функции были переданы неверными, никогда не  нужно их исправлять, чтобы сделать корректными. Вместо этого следует всегда сигнализировать об ошибке. Например, если параметр типа String, и для него было передано значение null, не нужно его исправлять, присваивая пустую строку; необходимо выбросить NullPointerException (что с большой вероятностью произойдёт автоматически).

  5. Если некоторый элемент управления подразумевает наличие метода, возвращающего выделенный объект, то он должен всегда называться selected().

  6. Результат показа всплывающей области должен возвращаться при помощи метода с именем result().

© 2012–2018 Разработчики LUWRAIN
Дизайн от Strash