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

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

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

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

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

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

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

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

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

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

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