Skip to content

Latest commit

 

History

History
153 lines (125 loc) · 9.93 KB

CONTRIBUTING.md

File metadata and controls

153 lines (125 loc) · 9.93 KB
Raw

Внески

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

Авторська угода

Здійснюючи внесок, ви погоджуєтеся з тим, що ми можемо поширювати вашу роботу згідно з [our license] (LICENSE.md). Натомність, ми розглянемо ваші питання та/або оцінимо вашу пропозицію щодо змін якнайшвидше, і допоможемо вам стати членом нашої спільноти. Усі учасники Software Carpentry, Data Carpentry та Library Carpentry погоджуються дотримуватися нашого code of conduct.

Як долучитися

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

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

  2. Якщо у вас є обліковий запис GitHub , або ви готові create one, але не знаєте, як використовувати Git, ви можете повідомити про проблеми або запропонувати покращення за адресою creating an issue. Це дозволить нам призначити питання комусь і відповісти на нього у поточному обговоренні.

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

Куди зробити внесок

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

  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.

Що внести

Є багато способів зробити внесок, від написання нових вправ і вдосконалення існуючих до оновлення або заповнення документації і подання bug reports про речі, які не працюють, незрозумілі або відсутні. Якщо ви шукаєте ідеї, дивіться, будь ласка the list of issues for this repository, або перелік проблем з Data Carpentry, Software Carpentry , і Library Carpentry проєктів.

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

Що не вносити

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

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

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

Якщо ви вирішите зробити внесок через GitHub, ви можете подивитися How to Contribute to an Open Source Project on GitHub. Якщо коротко:

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

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

  3. Створіть нову гілку у вашій локальній копії цього репозиторію для кожної значної зміни.

  4. Зафіксуйте зміну в цій гілці.

  5. Відправте зміни в локальному репозиторії в GitHub.

  6. Надішліть запит на зміни з цієї гілки до master repository.

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

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

Інші ресурси

Загальне обговорення щодо Software Carpentry, Data Carpentry та Library Carpentry відбувається в discussion mailing list, до якого можуть приєднатися всі бажаючі. Ви також можете [зв’язатися з нами електронною поштою] contact.