Внесение вклада в Feign

Прежде чем поднимать изменения, ознакомьтесь с HACKING.

Если вы хотите внести свой вклад в код, вы можете сделать это через GitHub, форкнув репозиторий и отправив pull request (на ветке, отличной от master или gh-pages).

Pull Requests

Pull requests в конечном итоге должны сводиться к одному коммиту. Журнал коммитов должен быть легко читаемым как журнал изменений. Мы используем следующую форму для достижения этого.

• Первая строка должна содержать описание в <=72 символах в настоящем времени, объясняющее, что это делает.
  • Пример: "Fixes regression on encoding vnd headers" > "Fixed encoding bug", что заставляет читателя смотреть на код, чтобы понять влияние.
• Не включайте ссылки на проблемы в первой строке, так как это делает pull requests странными.
  • Пример: "Addresses #345" становится заголовком pull request: "Addresses #345 #346"
• После первой строки используйте markdown для краткого изложения реализации.
  • Это не вместо комментариев, и это предполагает, что читатель не знаком с структурой кода.
• Если изменение закрывает проблему, укажите это в конце описания коммита, например: "Fixes #345"
  • GitHub автоматически закроет изменение с этой синтаксической конструкцией.
• Если изменение является значимым, также обновите журнал изменений вашим кратким описанием.
  • Нераспущенная младшая версия часто является хорошим значением по умолчанию.## Стиль кода

При отправке кода, пожалуйста, используйте конвенции форматирования кода Feign. Если вы используете Eclipse, m2eclipse должен автоматически управлять всеми настройками. Вы также можете импортировать настройки форматирования с помощью файла eclipse-java-style.xml. Если вы используете IntelliJ IDEA, вы можете использовать плагин Eclipse Code Formatter для импорта того же файла.

Лицензия

Подавая свой код, вы соглашаетесь с лицензией своего вклада на условиях APLv2.

Все файлы выпускаются с лицензией Apache 2.0.

Если вы добавляете новый файл, он должен иметь заголовок, подобный этому:

/**
 * Copyright 2012 The Feign Authors.
 *
 * Распространяется по лицензии Apache License, Version 2.0 (лицензия);
 * вы не можете использовать этот файл, кроме как в соответствии с лицензией.
 * Вы можете получить копию лицензии по адресу
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Если законодательство или письменное соглашение не требуют этого, программное обеспечение
 * распространяется по лицензии на условиях "КАК ЕСТЬ", БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ ИЛИ УСЛОВИЙ,
 * явных или подразумеваемых. См. Лицензию для определения языка, регулирующего права и
 * ограничения по лицензии.
 */