CONTRIBUTING.md

Прежде всего, спасибо, что нашли время внести свой вклад!🎉

Оглавление

Как я могу внести вклад?

• Сообщение об ошибках
• Предложение об улучшении
• Ваш первый вклад в качестве контрибьютора
• Добавление функциональности и исправление ошибок
• Создание документации
• Перевод документации

Использование лейблов

Как я могу внести вклад?

Сообщение об ошибках

Перед созданием заявки об ошибках, проверьте список заявок, возможно дублирующая заявка уже существует. Если вы нашли закрытую заявку об ошибке, которая похожа на вашу, не нужно ее переоткрывать. Заведите новую заявку и добавьте ссылку на существующую. Если найденная заявка открыта, отпишитесь в нее.

Перед заведением заявки проверьте, что ошибка воспроизводится на последней версии приложения.

1. Используйте понятные формулировки.
2. Укажите версию приложения, на которой возникла проблема.
3. Опишите конкретные шаги, которые приводят к проблеме. Считается хорошим тоном, если предоставлено как можно больше подробностей.
4. Опишите, что вы ожидали получить в результате своих действий и какой результат получен на самом деле.
5. Прикрепите сообщение об ошибке, которое отображена в браузере, прикрепите файл лога .log, конфигурационный файл application.properties.

Предложение об улучшении

Перед созданием предложения проверьте текущие заявки, возможно улучшение уже предложено. Если нет, заведите заявку и детально опишите предложение.

1. Используйте понятные формулировки.
2. Укажите какую версию приложения вы используете.
3. Предоставьте пошаговое описание предлагаемого усовершенствования как можно подробнее.
4. Опишите текущее поведение и объясните, какое поведение вы ожидаете увидеть и почему.
5. Объясните, почему это усовершенствование будет полезно для большинства пользователей.

Ваш первый вклад в качестве контрибьютора

Проблемы для новых контрибьюторов - проблемы, для которых требуется всего несколько строк кода. Заявки, с которых стоит начать, отмечены лейблом good for first issue.

Добавление функциональности и исправление ошибок

Исправление ошибок и разработка новой функциональности должна вестись в pull request, дублировать разработку заявкой не нужно. Если заявка существует, ее нужно прилинковать, добавив в description заявки последней строчкой текст Closes gh-NNN, где NNN - это номер существующей заявки, пример.

Создание документации

Если вы считаете, что какая-то часть работы приложения недостаточно хорошо задокументирована, расширьте документацию через pull request. Документация располагается в директории docs.

Перевод документации

Согласно данным Московской биржи и НРД доля нерезидентов в ОФЗ достигает 30%, а на рынке акций - 50%. Важным вкладом в развитие проекта является перевод существующей документации на другие языки.

Использование лейблов

Работа с заявками (issues) и пулл реквестами (pull request) должна вестись с использованием лейблов (labels).

После заведения заявки ей присваивается один из типов:

• Bug - проблема;
• Feature - новая функциональность;
• Improvement - улучшение существующей функциональности;
• Doc - запрос на доработку документации;
• Task - задача, тип которой не может быть отнесен ни к одной из предыдущих категорий;

и приоритет:

• critical - для отчетов об ошибке, которые приводят к неработоспособности приложения во всех случаях или при определенных обстоятельствах;
• major - для существенных улучшений функциональности, которые затрагивают широкий круг пользователей, или для ошибок приложения (например, ошибка подсчета доходности, выплат дивидендов, купонов, амортизации);
• minor - для улучшений функциональности, которые затрагивают узкий круг пользователей, или ошибок, не влияющих на основной функционал (например, опечатки).

Заявки для новых контрибьюторов помечаются лейблом good first issue.

В процессе работы контрибьютор может выставить на заявку или пулл реквест один из лейблов:

• help wanted - требуется помощь или информация от заявителя или другого контрибьютора;
• duplicate - если заявка или пулл реквест дублирует существующую, они связываются с существующими комментарием 'Duplicate of gh-NNN', новая заявка закрывается, пулл реквест закрывается без мерджа;
• invalid - если заявка или пулл реквест оформлена с ошибками, которые не могут быть исправлены (например, вандализм);
• wontfix - ошибки в работе приложения не найдено или в процессе обсуждения решено отклонить новую функциональность;
• limitation - имеется ограничение, не зависящее от команды разработки, которое не позволяет исправить ошибку или реализовать новую функциональность.

Заявка может быть закрыта:

• сразу после установки одного из статусов duplicate, invalid или wontfix.
• после мерджа связанного пулл реквеста.

Работа с репозиторием ведется в рамках следующих соглашений.

Инструкция разработчика поможет вам скомпилировать код и запустить приложение в среде разработки.