- 15
- 3
Всем привет,
На протяжении многих лет в среде разработки SA-MP, а теперь и open.mp, наблюдался дефицит единых стандартов. Хотя такие инструменты, как «SAMPCTL», и библиотеки, такие как «YSI», привнесли в экосистему современные рабочие процессы, подходы к структурированию кода, работе с кодировками и написанию скриптов по-прежнему остаются крайне разрозненными.
Чтобы устранить этот пробел, я представляю PST (Pawn Standards and Techniques) — открытую инициативу, основанную на участии сообщества и вдохновлённую PEP-документами Python, направленную на стандартизацию современной разработки на Pawn.
Официальный репозиторий: https://github.com/daniilkorochansky/pst
Начало состоит из первых двух проектов технических условий:
PST-0001 (Руководство по стилю кода): Обеспечение соблюдения четких стандартов форматирования (использование табуляции для отступов, стиль фигурных скобок по Allman, строгие соглашения об именовании) и устранение проблем с устаревшими кодировками путем введения явных комментариев о кодировке, вдохновленных PEP 263 (Python) (например,
PST-0002 (Структура проекта и включения): Отказ от монолитных файлов объёмом 100 тыс. строк в пользу чёткой, компонентной структуры с использованием современных систем подключения «y_hooks» и обязательных проверок включений.
Если вы согласны, не согласны или хотите предложить новый метод (например, современные подходы к работе с базами данных или шаблоны событий), пожалуйста, создайте задачу (Issue) или отправьте запрос на слияние (Pull Request), воспользовавшись шаблоном в репозитории.
На протяжении многих лет в среде разработки SA-MP, а теперь и open.mp, наблюдался дефицит единых стандартов. Хотя такие инструменты, как «SAMPCTL», и библиотеки, такие как «YSI», привнесли в экосистему современные рабочие процессы, подходы к структурированию кода, работе с кодировками и написанию скриптов по-прежнему остаются крайне разрозненными.
Чтобы устранить этот пробел, я представляю PST (Pawn Standards and Techniques) — открытую инициативу, основанную на участии сообщества и вдохновлённую PEP-документами Python, направленную на стандартизацию современной разработки на Pawn.
Официальный репозиторий: https://github.com/daniilkorochansky/pst
Что такое PST?
PST (Pawn Standards and Techniques) — это не набор обязательных правил, а сборник передовых практик, руководств по стилю и архитектурных шаблонов, согласованных сообществом с целью обеспечения читаемости и поддерживаемости кода, а также совместимости с инструментами.Начало состоит из первых двух проектов технических условий:
PST-0001 (Руководство по стилю кода): Обеспечение соблюдения четких стандартов форматирования (использование табуляции для отступов, стиль фигурных скобок по Allman, строгие соглашения об именовании) и устранение проблем с устаревшими кодировками путем введения явных комментариев о кодировке, вдохновленных PEP 263 (Python) (например,
// -*- coding: utf-8 -*-, для лучшей совместимости с IDE (Spawn IDE поддерживает эту возможность).PST-0002 (Структура проекта и включения): Отказ от монолитных файлов объёмом 100 тыс. строк в пользу чёткой, компонентной структуры с использованием современных систем подключения «y_hooks» и обязательных проверок включений.
Автоматизация и предоставление спецификации
Чтобы обеспечить удобный доступ к спецификации, PST рассматривается как платформа с непрерывным выпуском. Каждое обновление автоматически компилируется в аккуратный, стандартизированный сборник спецификаций в формате PDF, который вы всегда можете скачать из раздела «Releases» репозитория.Нам нужен ваш отзыв!
PST принадлежит сообществу. Я хочу официально пригласить разработчиков, в том числе авторов, ознакомиться с этими черновиками (Draft).Если вы согласны, не согласны или хотите предложить новый метод (например, современные подходы к работе с базами данных или шаблоны событий), пожалуйста, создайте задачу (Issue) или отправьте запрос на слияние (Pull Request), воспользовавшись шаблоном в репозитории.
