Внести свой вклад
Платформа Абрикос является открытым программным продуктом, в развитие которого может принять участие может любой желающий.
На сегодняшний день над платформой Абрикос проведена огромная работа.
Разработано множество решений на базе которых можно строить
различные масштабируемые интернет-проекты.
Но, платформа Абрикос, как и любой другой программный продукт не совершенен и
постоянно нуждается в тех или иных доработках. Причем доработки не обязательно
являются только программными.
Есть еще очень много различных направлений, которые нуждаются в вашем участии.
Будь то внешний вид, документация, или даже случайно допущенная простая
орфАграфическая ошибка - все это и многое другое находится в свободном доступе
с возможностью не пройти мимо и осуществить свой вклад.
Вклад в документацию
Документация - основа основ любого программного продукта. Без внятной
документации, будь то трижды супер-крутое решение не будет иметь
полноценного развития, тем более в сфере открытого программного обеспечения,
когда в этой документации остро нуждаются новые участники.
На сегодняшний день документация в платформе Абрикос крайне скудна и нуждается
в доработке.
Документация для разработчиков
Архитектура платформы Абрикос, структура модуля/шаблона продумана до мелочей.
Ориентир в проектировании был, прежде всего, определен на разработчика,
которому предстоит создавать решения на базе платформы.
Сегодня, разработка практически любого решения в платформе становится
понятным, легко масштабируемым, а главное простым в сопровождении.
Но, все возможности для разработчика открываются в полном
объеме только после того, как он смог изучить и понять основные каноны разработки.
Требуется немало усилий программисту, чтобы изучить технологии на базе существующих
исходников. Поэтому, порог вхождения для разработчика сегодня очень высок.
Снизить этот порог можно только одним способом - создать подробную документацию
с примерами использования различных технологий.
Существуют несколько способов (но не ограничены только ими), внесения своего вклада в документацию для разработчиков.
Внесение изменений в основной текст документации
Практически все исходные коды страниц официального сайта платформы Абрикос
доступны в репозитории на GitHub: https://github.com/abricos/abricos.org.
Шаги внесения изменений, дополнений в документацию следующие:
1. Регистрируетесь на GitHub;
2. Форкаете репозиторий в свою
учетную запись;
3. Вносите изменения в исходные коды страниц. Сделать это можно как минимум
двумя способами:
3.1. Средствами онлайн редактора на сайте GitHub;
3.2. Выгрузкой репозитория на локальный компьютер средствами git, с последующим коммитом
изменения в свою копию репозитория.
4. Сливаете внесенные изменения с официальным репозиторием пулреквестом.
5. После проверки ведущим разработчиком внесенных ваших изменений, они будут
выгружены на официальный сайт.
Изучение технологий разработки с последующим вкладом в документацию
Если вы не нашли ответа на свой вопрос в документации к платформе, публикуйте
свой вопрос на форуме. На этот вопрос обязательно
будет дан квалифицированный ответ.
После того, как вы окончательно разберетесь в своем вопросе, будет крайне
полезно преобразовать его в страницы документации. Это не займет много времени,
но тем самым ваш вклад существенно сократит время на изучения подобного вопроса
другим участникам сообщества платформы.
Документирование исходного кода
Если вы изучаете исходный код ядра платформы или модуля и встречаете функции, переменные, классы и т.п. без документации к ним, не оставляйте их без внимания, по возможности документируйте их согласно правилам документирования phpDocumentor. В последующем будет разработан инструмент автоматической генерации онлайн справки по ядру/модулю при добавлении в Каталог расширений.
Документация для конечного пользователя
Мы всегда стремимся создавать интерфейс пользователя простым и интуитивно понятным, но
этого не достаточно для конечного пользователя. Внятная онлайн справка по интерфейсу,
функционалу с картинками, а еще лучше с видео курсами существенно упростит
использование продукта конечному пользователю.
Осуществить свой вклад в документацию для него можно различными
способами.
Если вы не обладаете навыками программиста, но хотите осуществить свой вклад в платформу Абрикос и/или её приложений, достаточно создать документ в любом текстовом редакторе с поддержкой картинок, подробно описать в нем справку по функционалу и отправить этот документ на электронный адрес сообщества платформы info@abricos.org
Если вы обладаете навыками программиста, то создать или дополнить онлайн справку можно в репозитории определенного модуля (форка проекта в свою учетку, внесение изменений, слияние и отправку изменений через пулреквест).
Вклад во внешний вид платформы Абрикос
Любая иконка, картинка, стильное дизайнерское решения - все это и многое другое касательно внешнего вида будет неоценимым вкладом в платформу Абрикос. Ведь изначально, практически любой открытый программный продукт создается программистами, а не дизайнерами. Поэтому зачастую, внешний вид таких программных продуктов оставляет желать лучшего. Да, программисты создают мощные продукты, но эти продукты будут обречены на забвение, если они «режут» глаза пользователям. Именно ваши решения будут напрямую оценены пользователями продукта, потому как с ваших иконок, кнопок и прочих элементов интерфейса будет принято решение конечного пользователя о возможности продолжения использование продукта.
Вклад в продвижение платформы Абрикос
Краткий обзор, рекомендация, лайки в соцсетях или даже просто ссылка, оставленная вами на сторонних ресурсах сети Интернет, позволит другим людям узнать о ее существовании. А это в свою очередь пополнит ряды сообщества новыми участниками, которые оценят ее и так же осуществят свой вклад в ее развитие. Таким образом, ваше слово может обрести силу в сумме всех последующих вкладов участников сообщества пришедших по вашей рекомендации.
Иной вклад в платформу Абрикос
Охватить и описать все возможные способы внесения вклада в платформу Абрикос не
представляется возможным, потому как таких способов может быть бесчисленное
количество.
Но каждый ваш вклад, даже самый маленький, будет вкладом не только в платформу Абрикос,
но и вкладом в общее развития современной цивилизации.
Мы уверены в том, что именно открытые программные продукты призваны осуществлять
это развитие. Потому как мы не закрываем свои решения под замки патентов, а наоборот,
открываем и делимся ими со всеми желающими.
