Исправление или первоисточник можно прислать через форму предложений без работы с Git. Укажите адрес статьи, спорный фрагмент, исправление и ссылку, которая подтверждает факт. Код вики хранится в файлах Markdown; вклад в статьи разрешён по CC BY-SA 4.0.
Исправление без Git
Откройте форму предложений и опишите одну конкретную правку. Для названия модели, истории марки и совместимости нужен первоисточник: сайт изготовителя, руководство или датированный официальный документ. Реклама магазина и повторяющие друг друга пересказы не подтверждают факт автоматически.
Не отправляйте персональные данные, коды входа или чужие фотографии без разрешения.
Быстрый старт
Если репозиторий (откроется в новой вкладке) доступен вашему аккаунту, можно предложить Pull Request. Если ссылка не открывается, воспользуйтесь формой выше: доступ к документам и возможность прислать исправление не должны зависеть от GitHub.
- Форкните репозиторий — нажмите кнопку «Fork» на странице github.com/vixkosla/shisha-market (откроется в новой вкладке)
- Склонируйте свой форк —
git clone https://github.com/YOUR_USERNAME/shisha-market.git - Создайте ветку —
git checkout -b wiki/my-article - Отредактируйте файлы — все статьи находятся в
content/wiki/ - Запомните изменения —
git add . && git commit -m "Add article about..." - Отправьте в свой форк —
git push origin wiki/my-article - Создайте Pull Request — на странице вашего форка нажмите «New Pull Request»
Структура файлов
content/wiki/
├── index.md # Главная страница вики
├── brands/ # Статьи о производителях
│ ├── kaloud.md
│ ├── oduman.md
│ └── ...
├── categories/ # Статьи о категориях
│ ├── hookahs.md
│ ├── bowls.md
│ └── ...
└── guide/ # Руководства
└── contributing.md # Этот файлСтиль оформления
Заголовки
# Название статьи
## Раздел
### ПодразделТаблицы
| Колонка 1 | Колонка 2 |
|-----------|-----------|
| Значение 1 | Значение 2 |Ссылки
[Текст ссылки](relative/path.md)Списки
- Элемент списка
- Ещё один элемент
1. Нумерованный список
2. Второй пунктПравила
- Нейтральный тон — пишите как энциклопедия, без рекламы
- Проверяемые факты — для характеристик, истории и совместимости указывайте первоисточники и дату проверки
- Русский язык — все статьи на русском
- Без копирайта — не копируйте тексты с других сайтов
- Актуальность — обновляйте устаревшую информацию
Добавление новой статьи
- Создайте файл в соответствующей директории (
brands/,categories/) - Назовите файл строчными буквами с дефисами:
my-brand.md - Добавьте ссылку на статью в
index.md - Создайте Pull Request
Редактирование существующей статьи
- Найдите файл в соответствующей директории
- Отредактируйте содержимое
- Создайте Pull Request с описанием изменений
Модерация
Все Pull Requests проверяются перед слиянием. Убедитесь, что ваши изменения:
- Не содержат рекламы
- Не нарушают авторские права
- Соответствуют стилю вики
- Нейтральны по тону
Лицензия
Оригинальные статьи вики распространяются по лицензии CC BY-SA 4.0 (откроется в новой вкладке). Разрешены копирование, изменения и коммерческое использование с указанием авторства, ссылки на лицензию и внесённых изменений; производные материалы нужно распространять на тех же условиях.
Отправляя Pull Request в вики, вы предоставляете свой вклад по CC BY-SA 4.0. Авторство остаётся за вами. Отправляйте только собственные материалы или совместимые по лицензии переработки с сохранением обязательных указаний авторства; не обещайте права на чужие фотографии и логотипы.
Код приложения и техническая документация отдельно доступны по MIT. Исправления кода через Pull Request также разрешены и предоставляются по MIT. Лицензии не предоставляют права на персональные данные, пользовательские загрузки или товарные знаки.
Тексты разрешений проекта доступны без регистрации: MIT для кода и CC BY-SA 4.0 для вики.
Вопросы?
Вопросы и исправления можно отправить через форму предложений. При доступном репозитории также можно создать Issue. Рассмотрение не означает обязательного принятия правки.