Skip to content

Latest commit

 

History

History
60 lines (30 loc) · 4.72 KB

README.md

File metadata and controls

60 lines (30 loc) · 4.72 KB

Сниппеты для ZennoPoster

Набор пользовательских сниппетов (фрагментов исходного кода) для программы ZennoPoster/CodeCreator. Собираются и поддерживаются в актуальном состоянии благодаря энтузиастам с форума. Каждый желающий может присоединиться к нам и добавить свой сниппет (сделать Pull Request), главное оформить его согласно нижеописанным правилам.

Правила оформления сниппетов

  1. Файлы должны располагаться в директориях, именуемых согласно тематике сниппета за исключением одиночных файлов;

  2. В названии директорий необходимо присутствие квадратных скобок [] (без них в CodeCreator'е 5 можно спутать с файлом);

  3. Файлы должны иметь расширение, в соответствии с содержащимся в них языком (.cs, .fs, .js);

  4. Все сниппеты должны иметь кодировку UTF-8 без BOM;

  5. Необходимо использовать в файле либо табуляцию (по-старому), либо пробелы (.cs - 4 пробела, .js - 2 пробела), но не одновременно;

  6. В начале сниппета желательно присутствие подробного описания в комментарии;

  7. Код должен быть валидным и не должен вызывать ошибки компиляции;

  8. Если необходимо добавить класс/стороннюю библиотеку через GAC, то это необходимо описать в виде комментария.

Порядок добавления своих сниппетов

Полная инструкция

  1. Регистрация на GitHub

  2. Как сделать Fork и отправить Pull Request

Краткая инструкция

  1. Зарегистрироваться на GitHub

  2. Сделать Fork этого репозитория к себе в аккаунт, перейти в него

  3. Добавить новые сниппеты через кнопку "Create new file", предварительно приведя их к требованиям, описанным выше

  4. Сделать commit изменений в ветку master (или создать отдельную, где будут все добавляемые сниппеты)

  5. Отправить Pull Request и дождаться Code Review (проверка на ошибки и соответствие требованиям к оформлению). Пожалуйста, отнеситесь к этой процедуре с пониманием — она направлена только на повышение качества проекта

  6. Исправить найденные недочёты и сделать commit с этими изменениями

  7. После повторной проверки кода один из администраторов добавит ваши сниппеты в репозиторий (сделает merge)

Альтернативные инструкции:

Если у вас возникли сложности или есть вопросы, то вы всегда можете обратиться к кому-то из администраторов проекта напрямую или написать issue.