1
0
mirror of https://github.com/1C-Company/v8-code-style.git synced 2025-02-05 10:44:51 +02:00

#1 перенос правил контрибутинга

This commit is contained in:
Dmitriy Marmyshev 2021-05-21 14:19:41 +03:00
parent cbc1309cfa
commit bbd432868f
2 changed files with 10 additions and 7 deletions

View File

@ -24,7 +24,7 @@
#### Прежде чем зарегистрировать ошибку
* Проверьте [Wiki](https://github.com/1C-Company/v8-code-style/wiki) на наличие описания, что не является ошибкой
* Проверьте [Docs](https://github.com/1C-Company/v8-code-style/docs/) на наличие описания, что не является ошибкой
* Проверьте раздел [Issues](https://github.com/1C-Company/v8-code-style/issues), чтобы не создавать дубликатов
#### Как сообщить об ошибке эффективно

View File

@ -119,7 +119,7 @@ function-has-no-return-type
### Тип (issueType)
Тип найденной диагностики
Тип найденной проблемы/диагностики
- `ERROR` - Ошибка в приложении
- `WARNING` - Предупреждение о проблеме в приложении
@ -162,7 +162,7 @@ function-has-no-return-type
Соглашения при создании параметров:
1. имена параметров должны быть понятны в контексте проверки
2. имена параметров пишутся в `camelCase`, с маленькой буквы
2. имена параметров пишутся в `camelCase`, начиная с маленькой буквы, без пробелов, второе слово и далее с заглавной буквы
3. Константа с именем параметра должна быть публичной
4. Заголовок параметра должен быть локализован через NLS класс
@ -183,10 +183,13 @@ function-has-no-return-type
### Текст ошибки
1. В чем ошибка
2. Формат текста: существительное, именительный падеж
3. Указание значений параметров в сообщении
4. Сообщение должно быть локализовано через NLS класс
Текс ошибки должен отвечать на вопрос:
1. Какой объект содержит ошибку? В одной строке может быть несколько очень разных объектов. Объект желательно писать в именительном падеже.
2. В чем именно ошибка, что в коде не правильно?
3. При этом, указание наименования объекта - не обзятельно, но желательно - если оно не портит фразу.
4. Указание значений параметров в сообщении, если от значений зависит наличие ошибки.
5. Сообщение должно быть локализовано через NLS класс.
Примеры:
1. Переменная не была инициализирована