Skip to content

Добавлены правила оформления коммитов #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
magauran wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Добавлены правила оформления коммитов #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
* [Именование графических ресурсов](#именование-графических-ресурсов)
* [Структура файла](#структура-файла)
* [Структура проекта](#структура-проекта)
* [Оформление коммитов](#оформление-коммитов)

## Форматирование
### Пробелы и табуляция
Expand Down Expand Up @@ -260,16 +261,24 @@ func numericValue(of digit: UnicodeScalar, radix: Int = 10) -> Int {
* `RefreshBarButtonIcon` / `RefreshBarButtonIcon@2x` and `RefreshBarButtonIconSelected` / `RefreshBarButtonIconSelected@2x`
* `ArticleNavigationBarWhite` / `ArticleNavigationBarWhite@2x` and `ArticleNavigationBarBlackSelected` / `ArticleNavigationBarBlackSelected@2x`.

<!--Images that are used for a similar purpose should be grouped in respective groups in an Images folder.//-->

Изображения, используемые для одинаковых целей должны быть сгруппированы в папки.
##### Важно: Перед добавлением изображения в ассет, переименуйте его. Если переименовать изображение после добавления, имя файла останется прежним.

## Структура файла

## Структура проекта


## Оформление коммитов
Copy link
Copy Markdown
Contributor

@anivaros anivaros May 15, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Я для арма писал такие правила:

Работа с коммитами
Каждый коммит должен содержать в себе логически законченное изменение. В него не должны попадать какие либо другие изменения.

Комментарий к коммиту должен быть написан на русском языке, содержать ID и заголовок задачи и краткое описание изменения.

Пример комментария:

EW_IOS-98 требуется собрать приложение с использованием iBM Maas 360 SDK 2.95

Обновил структуру и настройки проекта

Обновил фреймворк MaaS

- Коммит должен содержать только одно логическое изменение.
- Первая строка коммита (Subject) должна содержать не более 72 символов.
Copy link
Copy Markdown
Contributor

@anivaros anivaros May 15, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Никто не будет считать символы)

- Message Subject и Message Body коммита должны быть разделены пустой строкой.
- Перед публикацией коммитов в удалённый репозиторий убедитесь, что все однотипные и незначительные коммиты были объединены.
- Создавая коммит, подумайте, какая информация понадобится вам, если вы наткнётесь на этот коммит через год.

Структура Message коммита:
> [Ключ задачи в JIRA] Краткое описание изменений.
Copy link
Copy Markdown
Contributor

@anivaros anivaros May 15, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 - зачем квадратные скобки?
2 - я все таки предлагаю писать не только код, но и название задачи, проще ориентироваться в коммитах будет, не надо каждый раз в джиру лезть

Copy link
Copy Markdown
Contributor Author

@magauran magauran May 24, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Чтобы как-то разделять от описания.
  2. Если добавлять ещё и название задачи, то ничего содержательного уже не поместится. И повторится та же проблема, что и сейчас - по Subject коммита не понятно, о чём он.

Может вообще название задачи в Description вынести?

Copy link
Copy Markdown
Contributor

@anivaros anivaros May 24, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

в Description

Это где?

>
> Более подробное описание изменений. Оно должно объяснять, почему требуются изменения, как они решают проблему, и какие могут возникнуть ошибки.

[comment]: # (Ссылки)
[the one true brace style]: https://en.wikipedia.org/wiki/Indentation_style#Variant:_1TBS_(OTBS)
Expand Down