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

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

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

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

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

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

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

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

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

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

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