- Баллы
- 153
Для того, чтобы администраторы серверов могли с легкостью найти и следить за ходом развития вашего плагина, мы внедряем строгие правила оформления тем. Только в строгом соответствии с ними ваш плагин попадет в раздел "Релиз плагинов" и в каталог плагинов.
Читайте полностью!
Требования:
Заголовок темы
Чтобы убедиться, что администраторы серверов могут получить ключевую информацию о плагине при одном только взгляде на заголовок темы, а также для улучшения поиска, мы устанавливаем определенные требования к оформлению заголовка.
Общий формат вашего заголовка должен быть таким:
[КАТЕГОРИЯ] PluginName v0.1 - описание [1.2.5-R3.0]
Где:
[КАТЕГОРИЯ] - это (если плагин входит более, чем одну категорию, названия категорий разделяются символом /, например [КАТ1/КАТ2]):
PluginName - название jar-файла вашего плагина без расширения .jar (для того, чтобы ваш плагин можно было легко найти по названию файла)
v0.1 - текущая версия вашего плагина
Описание - краткое описание функционала плагина
[1.2.5-R3.0] - версия рекомендованного релиза CraftBukkit, с которым был протестирован плагин. Версия CraftBukkit должна быть в пределах ТРЕХ ПОСЛЕДНИХ рекомендованных или бета билдов.
Лог изменений (changelog), другая информация:
Возможно, вам покажется это перебором, но для удобства администраторов серверов мы требуем в конце вашего сообщения указывать изменения в двух последних версиях плагина (если таковые есть) без скрытия этой информации в спойлере. Все остальные описания изменений в версиях должны быть спрятаны в тег spoiler. Так, администраторам не придется каждый раз раскрывать спойлер, чтобы свериться с изменениями в плагине.
Сверху лога изменений, пусть и необязательно, мы рекомендуем указывать другую важную информацию, как "Дальнейшие планы (Todo List)" и/или "Известные ошибки (Known Issues)", скрытые в теге spoiler. Смотрите шаблон темы ниже.
---------------
Актуальность вашего плагина:
Помимо активной поддержки вашего плагина, предоставления актуальных обновлений и - надеемся - добавления крутых, новых фич, мы ожидаем и требуем от вас потратить несколько минут на тестирование плагина и обновление заголовка вашей темы (указав, среди прочего, номер самого последнего рекомендованного билда CraftBukkit), как только появляется новый билд CraftBukkit.
Таким образом, как только модераторский состав начнет чистку неактивных плагинов, ваша работа не отправится в мусорную корзину.
О том, как редактировать заголовок вашей темы, читайте FAQ ниже.
Любой плагин, который не соответствует требованиям оформления, будет отправлен обратно в раздел "Неподтвержденные плагины".
---------------
Подсказки и шаблон оформления:
Ниже мы расскажем, как наиболее правильно представить ваш плагин сообществу, чтобы они захотели скачать его и возвращались обратно в вашу тему. В том числе, как максимально эффективно использовать пространство, чтобы упростить получение информации. Благодаря следованию единому шаблону, администраторы серверов могут с легкостью узнать о любом плагине без каких-либо замешательств.
Содержание релиза плагина
Вместе с правильно оформленным заголовком, некоторое время работы над содержательностью и представительностью вашей темы увеличит количество пользователей вашего плагина и уменьшит количество возможных вопросов, вызванных неправильным оформлением темы.
Первое правила правильного релиза - это связать название вашего .jar файла и название вашего плагина, что увеличит шанс нахождения вашего плагина по поиску. Например, если ваш плагин называется Red Power, то идеальным названием для .jar файла будет RedPower.jar.
Второе, вам нужно четко указывать текущую версию вашего плагина в самом сообщении, чтобы администраторы могли с легкостью определить ее (пусть даже версия уже и указана в названии темы).
Далее, и это, возможно, одна из самых важных частей, вы должны должным образом описать функционал вашего плагина: что он делает и как его использовать. Слишком много релизов плагинов содержат слишком мало информации о себе, а иногда и вовсе никакого описания - и это приводит к тому, что администраторы серверов попросту пропускают этот плагин (возможно, несправедливо) в поиске более дружелюбной альтернативы. Отсутствие должного описания часто признак того, что автор не особо заботится о своем плагине, и поэтому администраторы серверов не доверяют такой работе.
После описания, вам нужно разместить ссылки для скачивания как самого плагина (добавив зеркала, если возможно), так и исходников (если приемлемо).
Хотя для выполнения этих подсказок и требуется некоторая дополнительная работа, время и усилия с вашей стороны, но знакомый для посетителей шаблон оформления увеличит шансы потенциальных пользователей найти конкретную часть информации о вашем плагине, поскольку все плагины будут размещать одинаковый тип информации в одинаковом месте.
После всего этого, вам нужно разместить детальный лог изменений и, возможно, дальнейшие планы и известные ошибки. Лог изменений должен включать в себя как минимум две последние версии, и лог других версий в теге spoiler.
Шаблон
Демо шаблона
Читайте полностью!
Требования:
Заголовок темы
Чтобы убедиться, что администраторы серверов могут получить ключевую информацию о плагине при одном только взгляде на заголовок темы, а также для улучшения поиска, мы устанавливаем определенные требования к оформлению заголовка.
Общий формат вашего заголовка должен быть таким:
[КАТЕГОРИЯ] PluginName v0.1 - описание [1.2.5-R3.0]
Где:
[КАТЕГОРИЯ] - это (если плагин входит более, чем одну категорию, названия категорий разделяются символом /, например [КАТ1/КАТ2]):
PluginName - название jar-файла вашего плагина без расширения .jar (для того, чтобы ваш плагин можно было легко найти по названию файла)
v0.1 - текущая версия вашего плагина
Описание - краткое описание функционала плагина
[1.2.5-R3.0] - версия рекомендованного релиза CraftBukkit, с которым был протестирован плагин. Версия CraftBukkit должна быть в пределах ТРЕХ ПОСЛЕДНИХ рекомендованных или бета билдов.
Лог изменений (changelog), другая информация:
Возможно, вам покажется это перебором, но для удобства администраторов серверов мы требуем в конце вашего сообщения указывать изменения в двух последних версиях плагина (если таковые есть) без скрытия этой информации в спойлере. Все остальные описания изменений в версиях должны быть спрятаны в тег spoiler. Так, администраторам не придется каждый раз раскрывать спойлер, чтобы свериться с изменениями в плагине.
Сверху лога изменений, пусть и необязательно, мы рекомендуем указывать другую важную информацию, как "Дальнейшие планы (Todo List)" и/или "Известные ошибки (Known Issues)", скрытые в теге spoiler. Смотрите шаблон темы ниже.
---------------
Актуальность вашего плагина:
Помимо активной поддержки вашего плагина, предоставления актуальных обновлений и - надеемся - добавления крутых, новых фич, мы ожидаем и требуем от вас потратить несколько минут на тестирование плагина и обновление заголовка вашей темы (указав, среди прочего, номер самого последнего рекомендованного билда CraftBukkit), как только появляется новый билд CraftBukkit.
Таким образом, как только модераторский состав начнет чистку неактивных плагинов, ваша работа не отправится в мусорную корзину.
О том, как редактировать заголовок вашей темы, читайте FAQ ниже.
Любой плагин, который не соответствует требованиям оформления, будет отправлен обратно в раздел "Неподтвержденные плагины".
---------------
Подсказки и шаблон оформления:
Ниже мы расскажем, как наиболее правильно представить ваш плагин сообществу, чтобы они захотели скачать его и возвращались обратно в вашу тему. В том числе, как максимально эффективно использовать пространство, чтобы упростить получение информации. Благодаря следованию единому шаблону, администраторы серверов могут с легкостью узнать о любом плагине без каких-либо замешательств.
Содержание релиза плагина
Вместе с правильно оформленным заголовком, некоторое время работы над содержательностью и представительностью вашей темы увеличит количество пользователей вашего плагина и уменьшит количество возможных вопросов, вызванных неправильным оформлением темы.
Первое правила правильного релиза - это связать название вашего .jar файла и название вашего плагина, что увеличит шанс нахождения вашего плагина по поиску. Например, если ваш плагин называется Red Power, то идеальным названием для .jar файла будет RedPower.jar.
Второе, вам нужно четко указывать текущую версию вашего плагина в самом сообщении, чтобы администраторы могли с легкостью определить ее (пусть даже версия уже и указана в названии темы).
Далее, и это, возможно, одна из самых важных частей, вы должны должным образом описать функционал вашего плагина: что он делает и как его использовать. Слишком много релизов плагинов содержат слишком мало информации о себе, а иногда и вовсе никакого описания - и это приводит к тому, что администраторы серверов попросту пропускают этот плагин (возможно, несправедливо) в поиске более дружелюбной альтернативы. Отсутствие должного описания часто признак того, что автор не особо заботится о своем плагине, и поэтому администраторы серверов не доверяют такой работе.
После описания, вам нужно разместить ссылки для скачивания как самого плагина (добавив зеркала, если возможно), так и исходников (если приемлемо).
Хотя для выполнения этих подсказок и требуется некоторая дополнительная работа, время и усилия с вашей стороны, но знакомый для посетителей шаблон оформления увеличит шансы потенциальных пользователей найти конкретную часть информации о вашем плагине, поскольку все плагины будут размещать одинаковый тип информации в одинаковом месте.
После всего этого, вам нужно разместить детальный лог изменений и, возможно, дальнейшие планы и известные ошибки. Лог изменений должен включать в себя как минимум две последние версии, и лог других версий в теге spoiler.
Шаблон
Код:
TestPlugin - Тестовый плагин:
[B]Версия:[/B] v0.2
Это описание моего крутого плагина и информация о том, как его использовать (список команд, скриншоты, видео и др.)
[B]Особенности:[/B]
[LIST]
[*]Мой плагин делает торт
[*]И ест его
[/LIST]
Скачать тестовый плагин
Исходный код
[B]Лог изменений:[/B]
Версия 0.2
[LIST]
[*]Плагину добавлена возможность съест торт, который он делает
[/LIST]
Версия 0.1
[LIST]
[*]Релиз моего крутого плагина
[/LIST]Демо шаблона
