Skip to content

Latest commit

 

History

History
158 lines (129 loc) · 11 KB

CONTRIBUTING.md

File metadata and controls

158 lines (129 loc) · 11 KB
Raw

Внески до проєкту

Software Carpentry та Data Carpentry є проєктами з відкритим вихідним кодом, і ми вітаємо будь-які внески: нові уроки, виправлення наявного матеріалу, повідомлення про помилки та рецензування запропонованих змін - все це вітається.

Угода про участь у проєкті

Роблячи свій внесок, ви погоджуєтеся, що ми можемо розповсюджувати вашу роботу на умовах [нашої ліцензії] (LICENSE.md). В обмін на це ми розглянемо ваші зауваження та/або оцінимо вашу пропозицію щодо змін настільки швидко, наскільки це буде можливо, і допоможемо вам стати членом нашої спільноти. Кожен, хто бере участь у Software Carpentry та Data Carpentry, погоджується дотримуватися нашого кодексу поведінки.

Як зробити внесок

Найпростіший спосіб почати - це подати заявку про проблему, щоб повідомити нам про орфографічну помилку, певне некоректне формулювання або фактичну помилку. Це хороший спосіб заявити про себе і познайомитися з деякими членами нашої спільноти.

  1. Якщо у вас немає облікового запису GitHub, ви можете надіслати нам коментарі електронною поштою. Однак, ми зможемо відповісти швидше, якщо ви скористаєтеся одним з інших способів, описаних нижче.

  2. Якщо у вас є обліковий запис GitHub, або ви хочете створити його, але не знаєте, як користуватися Git'ом, ви можете повідомити про проблеми або запропонувати покращення, створивши запит. Це дозволяє нам призначити цей запит комусь і відповісти на нього в потоковому обговоренні.

  3. Якщо вам зручно працювати з Git'ом, і ви хотіли б додати або змінити матеріал, ви можете подати запит на зміни (англ. pull request, PR). Інструкції, як це зробити, наведені нижче.

Де робити внески

  1. Якщо ви хочете змінити цей урок, будь ласка, працюйте в https://github.com/swcarpentry/shell-novice, який можна переглянути на https://swcarpentry.github.io/shell-novice.

  2. Якщо ви бажаєте змінити шаблон уроку, будь ласка, працюйте в https://github.com/carpentries/lesson-example, який документує формат наших уроків, і з яким можна ознайомитись за посиланням https://carpentries.github.io/lesson-example.

  3. Якщо ви бажаєте змінити шаблон, який використовується для веб-сайтів семінарів, будь ласка, працюйте в https://github.com/carpentries/workshop-template. На головній сторінці цього репозиторію пояснюється, як налаштувати веб-сайти семінарів, а додаткові сторінки у https://carpentries.github.io/workshop-template надають більше інформації про наш вибір дизайну.

  4. Якщо ви хочете змінити файли стилів CSS, інструменти, або HTML-шаблон для уроків чи семінарів, що зберігаються в _includes або _layouts, будь ласка, працюйте в https://github.com/carpentries/styles.

Які внески робити

Існує багато способів зробити свій внесок, від написання нових вправ та покращення тих, що вже існують, до оновлення або додавання документації та подання звітів про помилки про речі, які не працюють, незрозумілі або відсутні. Якщо ви шукаєте ідеї, будь ласка, перегляньте перелік проблем для цього репозиторію, або перелік проблем для проєктів Data Carpentry та Software Carpentry.

Також вітаються коментарі щодо проблем та рецензування запитів на зміни: разом ми розумніші, ніж поодинці. Особливо цінні відгуки від початковців і новоприбулих: людям, які користуються цими уроками вже деякий час, легко забути, наскільки непроникним може бути деякий матеріал, тому свіжий погляд завжди вітається.

Які внески не слід робити

Наші уроки вже містять більше матеріалу, ніж ми можемо охопити на типовому семінарі, тому ми зазвичай не шукаємо більше понять чи інструментів, щоб додати до уроків. Як правило, якщо ви хочете представити нову ідею, ви повинні (а) оцінити, скільки часу знадобиться на викладання і (б) пояснити, що ви вилучите, щоб звільнити місце для цього. Перше заохочує авторів бути чесними щодо вимог; друге - добре подумати про пріоритети.

Ми також не шукаємо завдання чи інші матеріали, які працюють лише на одній платформі. На наших семінарах зазвичай присутні користувачі Windows, macOS та Linux; для того, щоб бути корисними, наші уроки повинні однаково добре працювати на всіх трьох платформах.

Використання GitHub

Якщо ви вирішили зробити свій внесок через GitHub, вам варто ознайомитися зі статтею Як зробити внесок у проект з відкритим вихідним кодом на GitHub. Якщо коротко:

  1. Опублікована копія уроку знаходиться у гілці gh-pages репозиторію (для того, щоб GitHub автоматично згенерував урок). Будь ласка, створюйте всі гілки звідти, і об'єднайте гілку gh-pages головного репозиторію з вашою гілкою gh-pages перед початком роботи. Будь ласка, не працюйте безпосередньо у вашій гілці gh-pages, оскільки це може ускладнити вашу роботу над іншими внесками.

  2. Ми використовуємо GitHub flow для керування змінами:

    1. Створіть нову гілку у вашій десктопній копії цього сховища для кожної суттєвої змінної.
    2. Внесіть зміни для цієї гілки.
    3. Натисніть цю гілку для відгалуження цього сховища на GitHub.
    4. Надішліть запит на приєднання цієї гілки до master repository.
    5. Якщо ви отримали зворотній зв'язок, зробіть зміни на вашому робочому столі і натисніть на гілку на GitHub: запит на приєднання оновиться автоматично.

  3. Цей репозиторій містить два сховища для зберігання фрагментів уроків: _episodes та _episodes_rmd. Щоб змінити епізоди, внесіть зміни до файлів у каталозі _episodes_rmd, а НЕ у каталозі _episodes. Файли Markdown у _episodes рендеритимуться автоматично з файлів RMarkdown у каталозі _episodes_rmd.

За кожний урок відповідають два супровідника, які переглядають проблеми і задовільняють запити на зміни або заохочують до цього інших. Супровідники є волонтерами спільноти, і мають вирішальне слово щодо того, що буде додано до уроку.

Інші ресурси

Загальне обговорення Software Carpentry та Data Carpentry відбувається у дискусійному списку розсилки, до якого може приєднатися кожен охочий. Ви також можете зв'язатися з нами електронною поштою.