forked from samdark/yiiframework_ru_cookbook
-
Notifications
You must be signed in to change notification settings - Fork 1
/
new.recipe.howto.txt
executable file
·121 lines (90 loc) · 5.94 KB
/
new.recipe.howto.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
Як написати новий рецепт
========================
> Note|Примітка: [вихідний код даного файлу] (https://github.com/samdark/yiiframework_ru_cookbook/blob/master/new.recipe.howto.txt)
можна використовувати як основу для нового рецепта.
Спочатку варто описати коротко суть того, що буде розказано або зроблено. Можна
привести основні думки списком:
- Як оформляти код.
- Як працювати з github.
- Як встановити git.
- Як додати рецепт у загальний зміст.
> Note|Примітка: для розмітки використовується markdown з невеликими доповненнями.
Список термінів можна подивитися
[в «Russian Translation Guidelines» на github] (https://github.com/yiisoft/yii/wiki/Russian-Translation-Guidelines).
Як оформляти код
-----------------
Код оформляється ось так:
~~~
[php]
$author = new User();
$author->postRecipe();
~~~
Якщо не вказати `[php]`, то код буде без підсвічування. Замість `[php]` можна вказати
`[css]`, `[javascript]`, `[html]` і інші мови.
Як встановити git і налаштувати його для роботи з github
--------------------------------------------------------
Git [дуже просто встановлюється на всіх операційних системах] (http://git-scm.com/downloads).
[Детальніше можна почитати на github] (https://help.github.com/articles/set-up-git).
Початкова конфігурація також не дуже складна.
Відкриваємо консоль, вказуємо імʼя, під якими будемо комітити і email,
який використовується на github.
~~~
git config --global user.name "Your Name Here"
git config --global user.email "[email protected]"
~~~
Можливо знадобиться [згенерувати ключик і додати його на github] (https://help.github.com/articles/generating-ssh-keys).
В якості візуального клієнта рекомендую [SmartGit] (http://www.syntevo.com/smartgit/index.html).
Як працювати з github
---------------------
### Початкове налаштування
- Йдемо в веб інтерфейс github, [на сторінку репозиторію з рецептами](https://github.com/samdark/yiiframework_ru_cookbook).
- Тиснемо кнопочку «Fork».
- Йдемо в свій репозиторій `https://github.com/your-nickname/yiiframework_ru_cookbook`.
- Копіюємо адресу свого репозиторію. Наприклад, `[email protected]:your-nickname/yiiframework_ru_cookbook.git`.
- Забираємо проект собі, додаємо `upstream`, що посилається на оригінальний репозиторій. Відкриваємо консоль:
~~~
git clone [email protected]:your-nickname/yiiframework_ru_cookbook.git
git remote add upstream [email protected]:samdark/yiiframework_ru_cookbook.git
~~~
### Новий рецепт або правки існуючого
- Відкриваємо консоль, забираємо останній код з оригінального репозиторію. Робимо
свою гілку для правок:
~~~
git fetch upstream
git checkout upstream/master
git checkout -b my-cool-changes
~~~
- Відкриваємо файли в улюбленому редакторі. Відмінно справляється PhpStorm з плагіном
«Markdown», якщо його налаштувати на текстові файли.
- Робимо необхідні правки.
- Відкриваємо консоль в тій самій директорії, додаємо наші правки, робимо комміт і
відправляємо в свій репозиторій:
~~~
git add .
git commit -m "опис ваших змін"
git push -u origin my-cool-changes
~~~
- Йдемо в веб-інтерфейс github в свій репозиторій.
- Вибираємо нашу гілку використовуючи селектор «branch:».
- Тиснемо кнопку «Pull Request», вводимо опис і відправляємо реквест.
Через якийсь час я отримую повідомлення про нові зміни, роблю
необхідні зауваження. Щоб їх виправити робляться правки тих самих файлів в тій
ж гілки і повторюється
~~~
git add .
git commit -m "опис ваших змін"
git push
~~~
повторно pull request робити при цьому не потрібно.
Після того, як зміни готові до публікації, я роблю merge і вони одразу ж
зʼявляються на сайті.
Як додати рецепт у загальний зміст
----------------------------------
Рецепт додається простим вписуванням його в файл
[`toc.txt`](https://github.com/samdark/yiiframework_ru_cookbook/blob/master/toc.txt).
---
- `Автор`: Александр Макаров, Sam Dark ([rmcreative.ru](http://rmcreative.ru/)).
- `Англомовний рецепт`: якщо це переклад, обовʼязково вказуйте оригінал.
- `Обговорення та коментарі`: можна посилатись на тему з обговоренням рецепту на
форумі.
- `Переклад на українську мову:` [Dmytro Voloshyn](http://echo.lviv.ua)