- Сообщения
- 1,536
- Реакции
- 2,324
- Помог
- 39 раз(а)
Предлагаю обсудить тут моменты, которые стоит учитывать и реализовывать, чтобы другим было приятнее пользоваться вашими творениями.
Все что вы выкладываете в общий доступ не должно попадать под ваши придуманные оговорки "Я писал это для себя, поэтому делал все, как мне удобно". Оно должно быть удобно, читабельно и понятно другим.
Это будет дополнением темы "Правильный стиль оформления кода в программировании"
1. Используйте GitHub
Он позволит вам удобно управлять вашим проектом, а другим изучать его в быстром и удобном доступе.
2. Храните настройки не только в исходном файле, а позволяйте так же выносить и использовать их в конфигах.
Редкие плагины требуют "одноразовой" установки значений и вы заставляете администратора игрового сервера каждый раз компилировать плагин.
3. Храните фразы в словарях через переменную, а не в исходном коде ввиде хардкода.
Берите за основу английский язык и по возможности расширяйте словарь своим родным языком. Сообщество так же сможет подключиться и помочь в вам в переводе на другие языки. Не лишайте их такого права.
4. Используйте понятный человеку changelog и последовательную нумерацию
Группируйте свои изменения в группы для читабельности. Маркируйте каждую версию новым порядковым номером, обычно используется последовательная нумерация, разделённая точкой: например, 1.5.2. Первое из них — старшая версия (major), второе — младшая (minor), третья — мелкие изменения (maintenance, micro).
Мы можем использовать простую систему группировки изменений согласно их влиянию на проект, которая будет разделена только на 4 группы:
А можем расширить их до таких групп:
Кто-то сможет дополнить данный список или может не согласен с текущим?
Тема во флуде, поэтому можем обильно все обсуждать и достичь общего стандарта для форума, если мировые стандарты кому-то не удобны.
Все что вы выкладываете в общий доступ не должно попадать под ваши придуманные оговорки "Я писал это для себя, поэтому делал все, как мне удобно". Оно должно быть удобно, читабельно и понятно другим.
Это будет дополнением темы "Правильный стиль оформления кода в программировании"
1. Используйте GitHub
Он позволит вам удобно управлять вашим проектом, а другим изучать его в быстром и удобном доступе.
2. Храните настройки не только в исходном файле, а позволяйте так же выносить и использовать их в конфигах.
Редкие плагины требуют "одноразовой" установки значений и вы заставляете администратора игрового сервера каждый раз компилировать плагин.
3. Храните фразы в словарях через переменную, а не в исходном коде ввиде хардкода.
Берите за основу английский язык и по возможности расширяйте словарь своим родным языком. Сообщество так же сможет подключиться и помочь в вам в переводе на другие языки. Не лишайте их такого права.
4. Используйте понятный человеку changelog и последовательную нумерацию
Группируйте свои изменения в группы для читабельности. Маркируйте каждую версию новым порядковым номером, обычно используется последовательная нумерация, разделённая точкой: например, 1.5.2. Первое из них — старшая версия (major), второе — младшая (minor), третья — мелкие изменения (maintenance, micro).
Мы можем использовать простую систему группировки изменений согласно их влиянию на проект, которая будет разделена только на 4 группы:
Added, Changed, Fixed и Removed.А можем расширить их до таких групп:
Added для новых функций.Changed для изменений в существующей функциональности.Deprecated для функциональности, которая будет удалена в следующих версиях.Removed для функциональности, которая удалена в этой версии.Fixed для любых исправлений.Security для обновлений безопасности.Многие не считают нужным повышать каждый раз версию своего плагина из-за каких-то недочетов.
Я считаю это не правильным, потому что при ошибках, я даже не могу сослаться на версию, в которой они возникли, т.к. автор решил маркировать изменения фразами "Правки в коде. Хотфикс. Мелкие недочеты. Исправил косяки и т.д." и мне придется дополнительно объяснять ему, какую версию "Мелкие недочеты" я имел ввиду.
Да и выглядит это ужасно и не компетентно, словно студент первого курса влил воду в свой реферат и считает, что так и надо.
Для сравнения возьмем записи:
Я считаю это не правильным, потому что при ошибках, я даже не могу сослаться на версию, в которой они возникли, т.к. автор решил маркировать изменения фразами "Правки в коде. Хотфикс. Мелкие недочеты. Исправил косяки и т.д." и мне придется дополнительно объяснять ему, какую версию "Мелкие недочеты" я имел ввиду.
Да и выглядит это ужасно и не компетентно, словно студент первого курса влил воду в свой реферат и считает, что так и надо.
Для сравнения возьмем записи:
Или короткие, но понятные правки
Сделаем более расширенный вариант записи по группам
Кто-то сможет дополнить данный список или может не согласен с текущим?
Тема во флуде, поэтому можем обильно все обсуждать и достичь общего стандарта для форума, если мировые стандарты кому-то не удобны.
