Ми б хотіли заохочувати усіх студентів та менторів долучатися до розробки цього курсу. Матеріали тут здебільшого розробляються та керуються командою менторів, але ми визнаємо що ми можемо робити помилки, або пропускати деякі речі. Ми створили деякі правила, які повинні допомогти вам почати робити свій внесок.
Дякуємо усім за допомогу в покращенні курсу для усіх!
Якщо у вас виникло запитання або проблема, і ви вважаєте що така ж ситуація могла б виникнути і в інших, спочатку прочитайте це.
Трекер проблем Гітхабу це канал якому ми надаємо перевагу при роботі з такими питаннями та проблемами. Він тримає питання публічними та надає можливість іншим долучатись з потенційними рішеннями, також він дбає про те, щоб все було задокументовано на майбутнє. Ця система створена не для особистих запитань, або проблем що не підходять для публічної бесіди, у таких ситуаціях ми пропонуємо звертатись до когось з команди менторів, що відповідає за цей курс.
Перед створенням нової проблеми, використайте пошук GitHub (або продивіться відкриті проблеми або закриті проблеми) щоб переконатись, що подібне запитання не ставив до вас ніхто. Якщо не знайшли - вперед, створюйте нову. Коли створюєте нову проблему, будь ласка, приділіть час на вибір точної та легко впізнаваної теми, після чого надайте якомога більше деталей в основний опис.
Приклади поганих тем:
- Проблема з матеріалами на поточній фазі
- Питання про курс
- Просто думка...
- Не можу виконати завдання
Приклади гарних тем:
- Завдання "Вступ в JS": не працює посилання на додатковий матеріал
- Завдання здати вправу "Додаток Pizza" 30-го лютого некоректне
- "Об'єктноорієнтований JavaScript" не має репозиторію з вихідним кодом
Ми також були б вдячні вам за ваші внески до матеріалів. Помітили помилку, або хотіли б додати ресурс? Використовуйте pull requests. Якщо хочете, щоб ваш пул реквест був опрацьований якомога скоріше, будь ласка продивіться наступні правила. Як тільки пул реквест буде створено, його можуть переглянути студенти та ментори. Коли ментор (або як правило хоча б два ментори) будуть вважати що все добре, пул реквест буде прийнятий та влитий в основну гілку.
- Переконайтесь що додані ресурси правильно надані, так само як схожі матеріали, які вже є у курсі. Це може бути додавання посилання на ресурс у описі завдання, або додавання цитати до вправи.
- Якщо ви додаєте вправу, то, будь ласка, виконайте наступне:
- використайте будь-яку уже присутню вправу як шаблон
- дайте файлу запропонованого завдання значущу назву
- розташуйте файл завдання у теці
tasks/ - зберігайте загальну структуру завдань
- залишайте бейджі
- додайте вашу вправу до
tasks/README.md- якщо ви не впевнені до якої саме фази додати вправу, то залишіть її десь під Новими запропонованими завданнями або До розгляду. Ви також можете додати будь-які коментарі.
- У вашому пул реквесті надайте розгорнутий опис того що саме ви хочете додати
та чому саме ви хочете це додати, або зробіть посилання на проблему яку ви
вирішуєте (наприклад,
Вирішує #121).
Будь ласка, переконайтесь що у вашому PR лише 1 чи 2, максимум 3 коміти. У іншому випадку, стисніть (squash) ваші коміти у декілька добре описаних та розділених коміти. Дуже важливо зберігати коміти атомарними, щоб залишати історію чистою. Нижче ви знайдете короткий гайд по тому як стискати коміти в чисту історію. Будь ласка, прочитайте: Chris Beams's - How to write a git commit message.
- Виконайте
git log --oneline master..your-branch-name | wc -l, щоб побачити скільки комітів у вашій гілці. - Виконайте
git rebase -i HEAD~#де#це номер комітів які ви зробили у своїй гілці. - Використайте інтерактивний rebase, щоб переробити вашу історію.
Якщо у вас немає вагомої причини залишити більше одного коміта, краще за все
помітити перший коміт як
r(reword) а усі інші якs(squash). Це дасть вам змогу залишити тільки перший коміт, та змінити його повідомлення.
Якщо ваш коміт виправляє якусь проблему (issue), будь ласка, залиште посилання на цю проблему. Це помітить проблему як закриту автоматично під час вливання. Приклад повідомлення для коміта:
Fixed broken link to w3schools in "Intro to HTML & CSS"
Resolves #111
Зверніть увагу на порожній рядок перед Resolves.... Все що йде після
порожнього рядка вважається додатковою інформацію та не буде виведено на екран,
якщо хтось просто шукає коміти в історії у компактному вигляді.
Не проблема!
Ви можете пройти Kent C. Dodds' How to Contribute to an Open Source Project on GitHub course. (14 уроків, кожний ~3 хвилини)