Skip to content

Написание комментариев к коммитам

Georgiy Bagretsov edited this page Oct 28, 2015 · 1 revision
  • Следует в каждом коммите делать одно логическое изменение. Если по каким-то причинам изменений больше одного, то необходимо начинать описание каждого изменения с новой строки, а в конце строк (кроме последней) ставить точку с запятой.
  • Длина строк основной части сообщения не должна превышать 80 символов.
  • Следует описывать изменения от третьего лица или безличным предложением.
  • Следует делать сообщения лаконичными, но в то же время точно описывать изменения.
  • Следует писать коммиты на английском языке.
  • Если Вы решали какую-либо задачу из текущего списка (Issues), следует проставить её номер в сообщении.
  • Если необходимо указать какую-либо дополнительную информацию, напишите её после основного сообщения, оставив пустую строку.
Хорошо:
Issue #3 - Fixed bug in login form;
Removed deprecated class AnotherClass

Important: After merge with master branch modules that use AnotherClass will not work anymore. Make sure to remove all dependencies before v1.2 release.


Плохо:
I added new method in my SomeClass
I also fixed some bugs and removed some deprecated stuff

Разработка

  1. Стили кодирования
  • [Java](Код стайл для языка Java)
  • [C/C++](Стиль написания кода на С )
  • [C#](Стиль написания кода на С# )
  • [Swift](Руководство по оформлению кода на языке Swift )
  • Написание комментариев к коммитам
  1. Android
  • Android DevGuide
  • [QR codes](Работа c QR на Android)
  • [Полезные вещи](Полезные вещи для Android разработки)
  • [Архитектура приложения](Архитектура приложения)
  • [Используемые компоненты](Используемые компоненты)
  • [Инструкция по сборке проекта](Инструкция по сборке проекта)
  1. iOS
  1. C и C++
  • [Использование CMake для проектов на C++ и C ](Использование CMake для проектов на C и CPP)

Описание

  1. Форматы файлов
  • [.bmp](Cтруктура хранения bmp файлов)
  • [.jpg](Cтруктура хранения jpg файлов)
  • [.png](Cтруктура хранения png файлов)
  1. Алгоритмы шифрования
  1. Примеры использования
  • [Библиотека матричной алгебры](Пример использования библиотеки матричной алгебры)
  1. Описание процесса кодирования файла
  2. Способ обезопасить использование приложения
  3. Java фасад библиотеки алгоритмов
  4. Алгоритм шифрования bmp на java заглушке

Тест-кейсы

  1. Матричная арифметика
  • [A+B](Сложение матриц)
  • [A*p](Умножение матрицы на скаляр)
  • [A*B](Умножение матриц)
  • [Обратные матрицы](Нахождение обратной матрицы)
  1. Взятие по модулю
  • [A mod p](Взятие матрицы по модулю простого числа)
  • [A mod P](Взятие матрицы по модулю - матрицы из простых чисел)
  1. Суперпозиция (модуль - простое число)
  • [A+B mod p](Сложение матриц по модулю простого числа)
  • [A*c mod p](Умножение матрицы на скаляр по модулю простого числа)
  • [A*B mod p](Умножение матриц по модулю простого числа)
  1. Суперпозиция (модуль - матрицы из простых чисел)
  • [A+B mod P](Сложение матриц по модулю - матрице простых чисел)
  • [A*c mod P](Умножение матрицы на скаляр по модулю - матрице простых чисел)
  • [A*B mod P](Умножение матриц по модулю - матрице простых чисел)

##Прочее

  1. [Утечки памяти](Memory Leaks)
  2. [Базовые цвета](Базовые цвета)
  3. [Clean Architecture](Clean Architecture)
Clone this wiki locally