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

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

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

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

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

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

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

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

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

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

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