1 В избранное 0 Ответвления 0

OSCHINA-MIRROR/ng-alain-ng-alain

Присоединиться к Gitlife
Откройте для себя и примите участие в публичных проектах с открытым исходным кодом с участием более 10 миллионов разработчиков. Приватные репозитории также полностью бесплатны :)
Присоединиться бесплатно
Клонировать/Скачать
CONTRIBUTING.md 15 КБ
Копировать Редактировать Web IDE Исходные данные Просмотреть построчно История
gitlife-traslator Отправлено 01.12.2024 18:03 b947106

Вклад в ng-alain

Мы будем рады, если вы внесете свой вклад в ng-alain и поможете сделать его еще лучше, чем он есть сегодня! Вот рекомендации, которым мы хотели бы, чтобы вы следовали:

Нашли ошибку?

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

<а name="функция"></а> Не хватает функции?

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

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

Рекомендации по отправке

Создание проблемы

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

Мы хотим исправить все проблемы как можно скорее, но прежде чем исправлять ошибку, нам нужно воспроизвести и подтвердить ее. Чтобы воспроизвести ошибки, мы систематически попросим вас предоставить минимальный сценарий воспроизведения с помощью http://plnkr.co. Наличие живого воспроизводимого сценария дает нам массу важной информации без необходимости возвращаться к вам с дополнительными вопросами, такими как:

  • используемая версия ng-alain;
  • сторонние библиотеки и их версии;
  • и самое главное — сценарий использования, который не работает.

Минимальный сценарий воспроизведения с использованием http://plnkr.co/ позволяет нам быстро подтвердить ошибку (или указать на проблему в коде), а также подтвердить, что мы исправляем правильную проблему. Если plunker не подходит для демонстрации проблемы (например, для проблем, связанных с нашей упаковкой npm), создайте отдельный git-репозиторий, демонстрирующий проблему.

Мы настаиваем на минимальном сценарии воспроизведения, чтобы сэкономить время сопровождающих и в конечном итоге иметь возможность исправлять больше ошибок. Интересно, что, по нашему опыту, пользователи часто сами находят проблемы в коде при подготовке минимального plunk. Мы понимаем, что иногда бывает трудно извлечь важные фрагменты кода из более крупной базы кода, но нам действительно нужно изолировать проблему, прежде чем мы сможем ее исправить.

К сожалению, мы не можем исследовать / исправлять ошибки без минимального воспроизведения, поэтому, если мы не получим от вас ответа, мы закроем проблему, которой недостаточно информации для воспроизведения.

Вы можете создать новые проблемы, заполнив нашу форму создания новой проблемы.

Отправка запроса на включение изменений (PR)

Прежде чем отправлять запрос на включение изменений, рассмотрите следующие рекомендации:

  • Поиск GitHub для открытого или закрытого PR, связанного с вашей отправкой. Вы не хотите дублировать усилия.

  • Внесите изменения в новую ветку git:

    git checkout -b my-fix-branch master
  • Создайте патч, включая соответствующие тестовые случаи.

  • Следуйте нашим правилам кодирования.

  • Запустите полный набор тестов ng-alain , и убедитесь, что все тесты пройдены.

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

    git commit -a
    ``` **Автоматическое добавление и удаление отредактированных файлов**
    
  1. Отправьте изменения в ветку на GitHub:

    git push origin my-fix-branch
  2. На GitHub отправьте pull request в ng-alain:master.

  3. Если мы предложим внести изменения, то:

    • Внесите необходимые обновления.
    • Заново запустите тестовые наборы ng-alain, чтобы убедиться, что тесты всё ещё проходят.
    • Перебазируйте вашу ветку и принудительно отправьте изменения в ваш репозиторий на GitHub (это обновит ваш запрос на pull):
    git rebase master -i
    git push -f

Это всё! Спасибо за ваш вклад!

После того как ваш pull request будет объединён

После того как ваш запрос на включение будет объединён, вы можете безопасно удалить свою ветку и извлечь изменения из основного (восходящего) репозитория:

  • Удалите удалённую ветку на GitHub через веб-интерфейс GitHub или локальную оболочку следующим образом:

    git push origin --delete my-fix-branch
  • Проверьте основную ветку:

    git checkout master -f
  • Удалите локальную ветку:

    git branch -D my-fix-branch
  • Обновите свой мастер последней версией восходящего потока:

    git pull --ff upstream master

Правила кодирования

Чтобы обеспечить согласованность исходного кода, помните об этих правилах во время работы:

  • Все функции или исправления ошибок должны быть проверены одним или несколькими тестами (юнит-тестами).
  • Все общедоступные методы API должны быть документированы.

Рекомендации по оформлению сообщений о фиксации

У нас есть очень точные правила относительно того, как можно форматировать сообщения git commit. Это приводит к более читаемым сообщениям, которые легко отслеживать при просмотре истории проекта. Кроме того, мы используем сообщения git commit для создания журнала изменений ng-alain.

Формат сообщения о фиксации

Каждое сообщение о фиксации состоит из заголовка, тела и нижнего колонтитула. Заголовок имеет специальный формат, который включает тип, область действия и тему:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Заголовок является обязательным, а область действия заголовка — необязательной.

Любая строка сообщения о фиксации не должна превышать 100 символов! Это позволяет сообщению легче читаться на GitHub, а также в различных инструментах git.

Нижний колонтитул должен содержать закрывающую ссылку на проблему, если таковая имеется.

Примеры: (ещё больше примеров)

docs(changelog): update change log to beta.5
fix(release): need to depend on latest rxjs and zone.js

The version in our package.json gets copied to the one we publish, and users need the latest of these.

Возврат

Если фиксация отменяет предыдущую фиксацию, она должна начинаться с revert: , за которым следует заголовок отменённой фиксации. В теле должно быть написано: «Это отменяет фиксацию <хэш>», где хэш — это SHA фиксации, которую отменяют.

Тип

Должен быть одним из следующих:

  • build: Изменения, влияющие на систему сборки или внешние зависимости (примеры областей: gulp, broccoli, npm).
  • ci: Изменения в нашей конфигурации CI и сценариях (примеры областей: Travis, Circle, BrowserStack, SauceLabs).
  • docs: Только изменения документации.
  • feat: Новая функция.
  • fix: Исправление ошибки.
  • perf: Изменение кода, которое улучшает производительность.
  • refactor: Изменение кода, которое не исправляет ошибку и не добавляет функцию.
  • style: Изменения, которые не влияют на смысл кода (пробел, форматирование, отсутствующие точки с запятой и т. д.).
  • test: Добавление недостающих тестов или исправление существующих тестов.

Тема

Тема содержит краткое описание изменения:

  • используйте повелительное наклонение, настоящее время: «изменить», а не «изменено» или «изменения».
  • не используйте заглавную букву в начале.
  • без точки (.) в конце.

Тело

Как и в теме, используйте повелительное наклонение, настоящее время: «измените», а не «изменённое» или «изменение». Тело должно включать мотивацию для изменения и противопоставлять его предыдущему поведению.

Нижний колонтитул

Нижний колонтитул должен содержать любую информацию о критических изменениях и также является местом для ссылки на проблемы GitHub, которые связаны с этой фиксацией. Closes.

Breaking Changes должны начинаться со слова BREAKING CHANGE: с пробелом или двумя переносами строки. Затем используется остальная часть сообщения коммита.

Подробное объяснение можно найти в этом документе.

Опубликовать ( 0 )

Вы можете оставить комментарий после Вход в систему

1
https://api.gitlife.ru/oschina-mirror/ng-alain-ng-alain.git
git@api.gitlife.ru:oschina-mirror/ng-alain-ng-alain.git
oschina-mirror
ng-alain-ng-alain
ng-alain-ng-alain
master