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

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

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

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

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

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

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

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

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

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

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