Образовательный проект CodenameCRUD: с нуля до junior fullstack developer
Ruby HTML CSS Other

README.md

CodenameCRUD

Codeship Status for codenamecrud/codenamecrud Code Climate Test Coverage

Что это за проект?

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

Более подробно: frey.su, onrails.club

Я хочу помочь, как это сделать?

Мы с радостью примем вашу помощь в двух направлениях: разработка приложения и перевод статей с английского языка на русский. Так же вы можете предложить другие варианты содействия любого рода: информационного, финансового, организационного или какого-либо другого. Для этого отправьте ваше предложение по адресу frey@list.ru.

Как помочь с разработкой приложения?

Если вы хотите внести свой вклад в само приложение, проделайте следующие шаги:

  1. Склонируйте репозиторий на свой компьютер:
git clone git@github.com:codenamecrud/codenamecrud.git
  1. Создайте новую ветку:
cd codenamecrud
git checkout -b new_branch
  1. Внесите желаемые изменения. Убедитесь, что покрыли их тестами и эти тесты успешно проходят. Список текущих задач доступен в разделе Issues этого репозитория, если хотите присоединиться к команде ресурса и совершенствовать его постоянно, напишите об этом по адресу frey@list.ru, вам датут доступ к организации проекта на Github.

  2. При написании кода для проекта мы стараемся руководствоваться принципами ruby style guide и ожидаем того же от любого, кто захочет внести свой вклад в развитие CodenameCRUD.

  3. Сделайте коммит. Напишите к нему краткое описание на английском языке не длиннее 72 символов, которые емко опишет внесенные изменения.

  4. Обновите свою ветку:

git fetch origin
git rebase origin/master
  1. Сделайте форк проекта:
git remote add mine git@github.com:<your user name>/codenamecrud.git

  1. Отправьте ваш коммит в форк:
git push mine new_codenamecrud_branch
  1. Создайте pull request:

    • Перейдите в репозиторий CodenameCRUD, в который вы только что отправили коммит (например https://github.com/your-user-name/codenamecrud)
    • Нажмите "Pull Request".
    • Введите название ветки в соответствующее поле (по-умолчанию там написано "master")
    • Нажмите "Update Commit Range".
    • Убедитесь, что внесенные вами изменения содержатся во вкладке "Commits".
    • Убедитесь, что "Files Changed" содержит все внесенные вами изменения.
    • Более детально опишите внесенные вами изменения и не забудьте добавить осмысленный заголовок.
    • Нажмите "Send pull request".
  2. С вниманием отнеситесь к оставленным к вашему коду комментариям. Не расстраивайтесь, если получите комментарии, содержащие предложения о внесении правок или указывающие на ошибки. Нам важно, чтобы в проекте был код, который можно было бы использовать в качестве наглядного пособия для новичков, а значит, он должен быть чистым и читаемым.