CONTRIBUTING.RU.md

Подготовьте вашу локальную среду разработки

Следующие шаги помогут настроить локальную среду разработки. Они нужны только если это ваш первый pull request в данный репозиторий.

1. Сделайте Fork этого репозитория на GitHub и склонируйте его в свою среду разработки.

git clone git@github.com:YOUR-GITHUB-USERNAME/yii2-db-rbac.git

2. Теперь нужно добавить мой репозиторий как дополнительный удаленный через "upstream"

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

git remote add upstream git://github.com/developeruz/yii2-db-rbac.git

Работа над ошибками и улучшениями

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

1. Получаем последнюю версию кода из основного репозитория

git fetch upstream

2. Создаем новую ветку от ветки master

Каждый баг-фикс или улучшение должны делаться в своей ветке. Имя ветки должно отражать суть изменений. Пример:

git checkout upstream/master
git checkout -b name-of-your-branch-goes-here

3. Творим свою магию

Убедитесь что она работает :)

4. Обновляем CHANGELOG

Внесите описание ваших изменений в файл CHANGELOG в начале файла. Строка изменений должна выглядеть так:

Bug: a description of the bug fix (Your Name)
Enh: a description of the enhancement (Your Name)

5. Закомитьте ваши изменения

Добавьте измененые файлы в git

git add path/to/my/file.php

Закомитьте ваши изменения с кратиким описанием их сути.

git commit -m "A brief description of this change"

6. Стяните последние изменения с основного репозитория

git pull upstream master

Если есть какие-то конфликты, вы должны исправить их прежде чем создавать pull request. Это позволит принять ваши изменения в один клик.

7. После исправления конфликтов, пушим изменения в свой репозиторий

git push -u origin name-of-your-branch-goes-here

8. Создаем pull request для основного репозитория.

Откройте свой репозиторий на Github и кликните "Pull Request".

Спасибо за сотрудничество!