Skip to content

Latest commit

 

History

History
40 lines (31 loc) · 4.11 KB

CONTRIBUTING.md

File metadata and controls

40 lines (31 loc) · 4.11 KB
Raw

Как внести свой вклад

Необходимо понимать, что тестирование и составление багрепортов - столь же важный этап развития проекта, как и PullRequest. Поэтому если вы желаете помочь развивать DocLister, то эти рекомендации специально для вас.

Прежде чем создать билетик

  • Заведите себе аккаунт на GitHub
  • Создавайте билетики по какому-либо вопросу, если таковые еще не существуют
    • Присылая баг-репорт укажите версию php, MySQL и MODX Evolution/ClipperCMS
    • Приведите пример вызова DocLister-а и исходный код ваших контроллеров/экстендеров/prepare сниппетов
    • Если вопрос частично касается или зависит от какого-то другого вопроса - то укажите его номер

Прежде чем прислать PullRequest

  • Убедитесь, что ваш код не содержит ошибок
  • Используйте API DocLister'а
  • Убедитесь, что код с вашими правками не конфликтует с текущей версией DocLister'a
  • Если ваш PullRequest решает какой-либо вопрос - то в комментариях укажите его номер. В противном случае подробно опишите как могут быть полезны проекту ваши правки

Тестирование

Для DocLister-а нет Unit-тестов. Поэтому все тестирование напрямую зависит от внимательной проверки результатов работы сниппета.

Во время тестирования так же важно проверять обратную совместимость сниппета. Базовые примеры указаны в документации и на сайте http://doclister.agelnash.ru

Пожалуйста, сообщайте обо всех обнаруженых недочетах при помощи GitHub билетиков.

Перевод

На данный момент DocLister не так активно работает с другими языками. Но тем не менее, такой функционал уже заложен и используется как минимум в экстендере paginate.

Поэтому если вы владете каким-либо языком - то можете проверить корректность переводов или предложить свой вариант для языка на который еще не переведены сообщения.

Документация

Документация устаревает намного быстрее, чем пишется. Поэтому если вы заметили ошибку в документации или обнаружили параметр который еще не описан, то при помощи билетиков можете сообщенить об этом. Приветствуется попытка самостоятельно документировать недостающий параметр.

Донат

Если вам нравится DocLister, но лень тестировать/проверять документацию и переводы, не знаете php или просто не умете пользоваться git, то можете внести вклад в развитие проекта при помощи пожертвований.