D.2.4 Отправка исправлений для Octave

Если вы хотите внести исправления ошибок или улучшения в Octave, это очень полезно. При отправке ваших изменений, пожалуйста, следуйте этим рекомендациям, чтобы избежать дополнительной работы для нас при изучении исправлений.

Если вы не следуете этим рекомендациям, ваша информация всё ещё может быть полезной, но её использование потребует дополнительной работы. Поддержка Octave — это большая работа в любых обстоятельствах, и мы не можем справиться, если вы не сделаете всё возможное, чтобы помочь.

• Приложите объяснение к вашим изменениям, описывающее, какую проблему они исправляют или какое улучшение они приносят. Для исправления ошибки просто включите копию отчёта об ошибке и объясните, почему это изменение исправляет ошибку.
• Всегда прикладывайте соответствующий отчёт об ошибке для проблемы, которую, по вашему мнению, вы исправили. Нам нужно убедиться, что изменение верно перед его установкой. Даже если оно правильно, у нас могут возникнуть трудности с его оценкой, если у нас нет способа воспроизвести проблему.
• Включите все необходимые комментарии, которые помогут людям, читающим исходный код в будущем, понять, почему это изменение было необходимо.
• Не смешивайте изменения, сделанные по разным причинам. Отправляйте их по отдельности.

  Если вы внесли два изменения по разным причинам, возможно, мы не захотим установить их оба. Мы можем захотеть установить только одно.

• Используйте ‘diff -c’ для создания ваших различий. Различия без контекста трудно для нас установить надёжно. Более того, они затрудняют изучение различий, чтобы решить, хотим ли мы их установить. Объединённый формат различий лучше, чем различия без контекста, но не так легко читается, как формат ‘-c’.

  Если у вас есть GNU diff, используйте ‘diff -cp’, который показывает имя функции, в которой происходит каждое изменение.

• Напишите записи журнала изменений для ваших изменений.

  Прочитайте файл ChangeLog, чтобы увидеть, какой тип информации нужно вставлять и узнать стиль, который мы используем. Цель журнала изменений — показать людям, где найти то, что было изменено. Поэтому вы должны быть конкретны в отношении функций, которые вы изменили; в больших функциях часто полезно указать, где именно в функции было внесено изменение.

  С другой стороны, после того, как вы показали людям, где найти изменение, вам не нужно объяснять его цель. Таким образом, если вы добавили новую функцию, всё, что вам нужно сказать о ней, — это то, что она новая. Если вы считаете, что цель требует объяснения, это, вероятно, так — но объяснение будет намного полезнее, если вы поместите его в комментарии в коде.

  Если вы хотите, чтобы ваше имя появилось в строке заголовка, указывающей, кто внес изменение, отправьте нам строку заголовка.