mirror of
https://github.com/1C-Company/v8-code-style.git
synced 2024-12-11 05:11:43 +02:00
6.0 KiB
6.0 KiB
Участие в проекте 1С:Стандарты разработки V8
Содержание
- У меня есть вопрос
- Что я должен знать прежде чем начать
- Сообщить об ошибке
- Предложите улучшение функциональности
- Доработка кода
Вначале хотим поблагодарить Вас за желание участвовать в проекте!
Далее описаны советы, как сделать свое участие наиболее эффективным для проекта и для себя. Будьте благоразумны, если что-либо здесь не описано.
У меня есть вопрос
- Для начала убедитесь, что ответа нет в самой 1C:EDT.
- Поищите информацию в документации проекта
Вопрос есть, но ответа не нашел? Создай issue
Что я должен знать прежде чем начать
Изучите текущую функциональность проекта, цели проекта, где находится граница возможностей плагина и 1C:EDT.
Вопросы, которые не относятся к разработке приложений в 1C:EDT по стандартам 1С, следует задавать в профильных сообществах.
Сообщить об ошибке
Печально, что ошибка существует, но мы благодарны, что вы о ней нам сообщите!
Прежде чем зарегистрировать ошибку
- Проверьте Docs на наличие описания, что не является ошибкой
- Проверьте раздел Issues, чтобы не создавать дубликатов
Как сообщить об ошибке эффективно
Следуйте простым правилам:
- Задайте понятный заголовок
issue
, лаконично и исчерпывающе определяющий проблему- постарайтесь не допускать двойного смысла, сленга из других областей и т.д.
- Не используйте "метки" в заголовке - для этого используются метки (labels) на гитхабе
- Опишите сценарий воспроизведения ошибки.
- скриншоты очень сильно помогают, но не заменяют сценарий
- добавьте логи ЖР, из лог-файлов (убедитесь, что они не содержат приватной информации)
- Опишите, что есть ошибка по вашему мнению и почему
- Опишите ожидаемое поведение
Ложное срабатывание проверки или проверка не находит ошибку
Мы будем благодарны, если Вы сообщить нам о ложном срабатывании проверки или о не нахождении существующей ошибки.
Предложите улучшение функциональности
- Задайте понятный заголовок
issue
, лаконично и исчерпывающе определяющий новую функциональность - Опишите суть улучшений и обсудите в issue варианты реализации.
- Убедитесь совместно с авторами проекта, что ваше предложение не противоречит идеологии Стандартов 1С и 1C:EDT. При этом авторы проекта всегда рады обсуждению новых идей, всегда на стороне участников, предлагающих улучшения, но при этом постараются максимально разъяснить случаи отказа в принятии идеи/реквеста, если таковые возникнут.
- Реализуйте Ваше улучшение функциональности проекта в отдельном форке и предложите его через Pull/merge request