Для авторов кода
1) Полностью рабочий код.
- Пишите тесты. Можете добавить их позднее, но, лишними они в любом случае не будут.
- О тестировании в Yii 1.1.
- О тестировании в Yii 2.0.
2) Документация методов и классов в коде.
- как форматировать.
- Для охвата наибольшей аудитории лучше писать на английском языке.
3) Единый стиль кодирования в соответствии с каким-то стандартом:
- PSR-1.
- PSR-2. Используется Yii 2.
- Yii 1.1.
4) Используйте систему контроля версий.
Предпочтительно git и github. Последний позволяет удобно собирать баг репорты и запросы на добавление новых функций, организовать работу с другими программистами.
5) Интернационализация
- Если в вашем расширении используются какие-то строки (ошибка валидации, сообщения в лог), то используйте механизмы интернационализации.
- О переводе в Yii 1.1
- О переводе в Yii 2.0
6) Простая установка.
- Используйте composer.
- Про него же на хабре: http://habrahabr.ru/post/145946/
7) README.md
- Должна быть инструкция по установке и применению кода.
8) Поддержка.
- Не забрасывайте свой код.
- Если нет времени — передайте тем, у кого оно есть.
9) CHANGELOG.md
Описывайте изменения в коде. Это позволит пользователям легко обновиться.
10) LICENSE.md
Обязательно приложите к коду лицензию. Рекомендуется BSD или MIT.
11) Адекватно реагируйте на критику
Не вступайте в неконструктивные баталии, не тратьте свое и чужое время на выяснения отношений.
Пользователям стороннего кода и библиотек
1) Соблюдайте этикет общения
- Критикуйте конструктивно т.е. «как лучше», а не «всё плохо».
- Не оскорбляйте авторов кода. Они вложили в него силы и время.
2) Понравилось — напишите автору. Это поднимет его моральных дух и, возможно, он напишет ещё.
3) Помогайте другим.
- Напишите статью об использовании стороннего кода.
- Расскажите о хорошей библиотеке.
- Исправьте ошибки и пошлите pull request.
Любые пожелания приветствуются, обсуждение здесь
Прочесть всем! Рекомендации для авторов кода и пользователей
-
- Сообщения: 1428
- Зарегистрирован: 2009.08.20, 22:54
- Откуда: Молдова, Бельцы
- Контактная информация:
Re: Прочесть всем! Рекомендации для авторов кода и пользоват
Александр Макаров (Sam Dark) выложил похожий набор рекомендаций, но, уже по работе над open source php-кодом вообще. Ознакомиться можно здесь.