Співпраця безпосередньо у репозиторії GitHub

Пряма співпраця через GitHub зручна, якщо ви хочете регулярно виправляти сторінки, створювати нові Markdown-файли або працювати з сховищем CircusWiki в редакторі на кшталт Obsidian.

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

Назад до "Долучитися"

Що вам знадобиться¶

• безкоштовний обліковий запис GitHub: https://github.com/join
• необов'язково GitHub Desktop: https://desktop.github.com/
• текстовий редактор для Markdown-файлів, наприклад Obsidian, VS Code або простий редактор

GitHub Desktop не є обов'язковим, але для багатьох людей він простіший за командний рядок.

Знайти репозиторій¶

Публічний репозиторій знаходиться тут:

https://github.com/nica-ev/circuswiki

Там зберігаються фактичні Markdown-файли, зображення, переклади та інструменти, з яких будується вебсайт.

Робота в короткій формі¶

Типовий процес виглядає так:

1. Створити форк репозиторію на GitHub.
2. Клонувати свою копію на власний комп'ютер.
3. Вносити зміни в новому гілці.
4. Редагувати файли або створювати нові Markdown-файли.
5. Зробити коміт змін.
6. Завантажити гілку на GitHub.
7. Відкрити Pull Request, щоб зміну можна було перевірити та прийняти.

Крок за кроком з GitHub Desktop¶

1. Створити форк репозиторію¶

Відкрийте репозиторій CircusWiki на GitHub:

https://github.com/nica-ev/circuswiki

Натисніть Fork. Це створить власну копію репозиторію у вашому обліковому записі GitHub. У цій копії ви можете працювати, не змінюючи безпосередньо основний проєкт.

2. Клонувати репозиторій¶

Відкрийте GitHub Desktop і виберіть:

File -> Clone repository...

Виберіть свій форк nica-ev/circuswiki і вкажіть папку на своєму комп'ютері.

Після цього у вас буде локальна копія файлів.

3. Створити гілку¶

Для вашої зміни найкраще створити окрему гілку, наприклад:

spiel-beschreibung-ergaenzen
link-korrigieren
neue-methode-balancieren

Гілка зберігає вашу роботу окремо від основного стану. Це полегшує подальшу перевірку.

4. Редагувати файли¶

Публічний контент переважно знаходиться в мовних папках під docs/:

docs/de/
docs/en/
docs/es/
docs/pl/
...
docs/img/

Усі мови є рівноцінними. Немає основної мови, якою б створювався новий контент.

Якщо ви створюєте нову оригінальну сторінку, розмістіть її в мовній папці, мовою якої написаний текст. Наприклад, оригінальний іспанський текст належить до docs/es/, німецький — до docs/de/, англійський — до docs/en/.

Важливим є Frontmatter на початку файлу. Там має бути зазначено, що сторінка є оригіналом, наприклад:

translation_status: original
translation_source_lang: es

translation_source_lang відповідає мові оригінального тексту. З цього оригіналу пізніше можна автоматично генерувати переклади всіма підтримуваними мовами.

Під час редагування зверніть увагу на наступне:

• Не видаляйте Frontmatter на початку файлу.
• Для нових оригінальних сторінок встановіть translation_status: original та відповідний translation_source_lang.
• За можливості зберігайте існуючі посилання.
• Не публікуйте приватні дані, ключі API або внутрішні нотатки.
• Використовуйте зображення лише тоді, коли права на використання чіткі.
• Краще робити невеликі, чіткі зміни, ніж дуже великі змішані зміни.

5. Зробити коміт змін¶

У GitHub Desktop ви побачите змінені файли в розділі Changes.

Напишіть короткий опис, наприклад:

Korrigiere Materialliste im Bewegungsspiel
Ergänze Sicherheitshinweis zu Beigoma
Füge neue Spielbeschreibung hinzu

Потім натисніть Commit to <branch-name>.

6. Завантажити зміни¶

Натисніть Push origin, щоб завантажити свою гілку на GitHub.

7. Відкрити Pull Request¶

GitHub Desktop або GitHub у браузері запропонують створити Pull Request.

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

Основи Markdown¶

Markdown — це простий текстовий формат. Найважливіших символів достатньо для більшості внесків:

# Великий заголовок
## Заголовок розділу

Звичайний текст із **жирним виділенням** та *курсивним виділенням*.

- Пункт списку
- Ще один пункт списку

[Текст посилання](https://www.example.com)

Якщо щось незрозуміло¶

Не обов'язково одразу досконало вміти працювати з GitHub. Якщо ви відкриєте Pull Request, а щось ще не так, це можна буде з'ясувати під час перегляду.

Якщо ви хочете лише додати контент, а технічний шлях здається занадто складним, просто скористайтеся електронною поштою на сторінці "Долучитися".