6.4 KiB
Руководство для участников проекта
Как я могу помочь проекту?¶
Канборд пока не идеален, поэтому есть несколько вариантов помочь проекту:
- Присылать отзывы
- Сообщать об ошибках
- Добавлять или обновлять переводы
- Улучшать документацию
- Писать код
- Рассказать друзьям, что Канборд отличная программа :)
Перед тем как начать большое дело, создайте новое “обсуждение вопроса” (issue) на https://github.com/fguillot/kanboard/issues и объясните ваше предложение.
Я хочу внести предложения по проекту¶
- У вас есть идея по улучшению (пользовательский интерфейс или другие возможности)
- Посмотрите в обсуждениях (issue), может ваша идея уже предложена кем-то
- Откройте новое обсуждение (issue)
- Опишите вашу идею
- Вы можете проголосовать +1 за имеющиеся предложения
Я хочу сообщить об ошибке¶
- Убедитесь, что обсуждение вопроса (issue) ранее не публиковалось
- Откройте новую заявку (ticket)
- Опишите, что именно не работает
- Опишите, как воспроизвести ошибку (последовательность, как вы вышли на данную ошибку)
- Опишите ваше окружение (версию Канборда, какая ОС, веб сервер, версию PHP, база данных и версия, хостинг провайдер)
Я хочу перевести Канборд на другой язык¶
Канборд уже переведен на несколько языков. Вы можете улучшить эти переводы. Некоторые переводы еще не завершены. Для того, чтобы сделать перевод, ознакомтесь с руководством по переводу на другой язык.
Я хочу улучшить документацию¶
- Вы считаете, что что-то недостаточно хорошо описано, имеются грамматические или орфографические ошибки, что-то еще.
- Документация написана в формате Markdown и хранится в каталоге
docs{.docutils .literal}. - Редактируйте файлы и присылайте pull-request.
- Документация на официальном вебсайте синхронизируется с репозиторием.
Я хочу внести свой вклад в код¶
Pull-requests всегда приветствуются, однако, чтобы они были приняты, вы должны следовать следующим указаниям:
- Перед тем как внести большое изменение или переделать дизайн, откройте новую заявку (ticket) для обсуждения.
- Если вы хотите добавить новую возможность, уважайте филосовию Канборда: Мы фокусируемся на простоте, мы не хотим иметь раздутую программу.
- Это же относится и к пользовательскому интерфейсу: простота и производительность
- Присылайте только по одному pull-request для новой возможности или исправления ошибки.
- Небольшие pull-request легче просмотреть и быстрее влить в проект.
- Убедитесь, что модульные тесты выполняются успешно.
- Уважайте стандарты кодирования.
- Пишите код, который могут поддерживать другие, избегайте дублирования, используйте лучше практики PHP.
В любом случае, если вы не уверены в чем-то - открывайте новую заявку (ticket)
Рассказать друзьям, что Канборд отличная программа :)¶
Если вы используете Канборд, покажите его и окружающим. Расскажите всем о прелестях бесплатного и опенсурсного программного обеспечения.