Как внести изменения

fillis.ru — открытый проект. Предложить правку текста, перевод, новую книгу или исправление кода может любой. Вклад можно внести двумя способами:

Pull Request — вы сами вносите изменения в репозиторий, а мы их проверяем и принимаем;
задача — вы описываете идею или проблему, а изменения вносят участники проекта.

Присылая изменения, вы соглашаетесь с условиями вклада (см. в конце страницы).

Вклад через Pull Request

Войдите в GitVerse. Для участия нужна учётная запись на GitVerse. Если её нет, зарегистрируйтесь — это займёт пару минут.
Создайте форк репозитория. Откройте https://gitverse.ru/fillis/fillis.ru/fork, заполните форму и нажмите Форкнуть репозиторий. В вашем профиле появится личная копия проекта: https://gitverse.ru/<ваш_профиль>/fillis.ru.

Клонируйте форк на компьютер.

git clone https://gitverse.ru/<ваш_профиль>/fillis.ru.git
cd fillis.ru

Создайте ветку для изменений. Для каждого отдельного изменения нужна своя ветка.
```
git checkout -b fix/typo-in-foreword
```
Примеры названий: fix/typo-in-foreword, add/new-translation-intro.
Внесите изменения и проверьте их локально. Нужны Node.js 18 или новее и npm 9 или новее.
```
npm install
npm run dev
```
Сайт откроется по адресу http://localhost:8080.

Зафиксируйте изменения и отправьте их в форк.

git add .
git commit -m "Краткое описание изменений"
git push origin fix/typo-in-foreword

Создайте запрос на слияние. В своём форке на GitVerse откройте раздел Запросы и нажмите Создать новый запрос. Базовый репозиторий — fillis/fillis.ru, базовая ветка — master. Коротко и понятно опишите, что изменено и зачем.
Дождитесь проверки. Участники проекта рассмотрят запрос и, если нужно, зададут вопросы или предложат правки. Одобренный запрос вливается в master, и изменения автоматически появляются на https://fillis.ru. После первого принятого вклада вас добавят в список участников сообщества.

Вклад через задачу

Если вы не готовы вносить правки сами, но хотите предложить идею или сообщить о проблеме:

Откройте раздел Задачи репозитория на GitVerse.
Нажмите Добавить задачу.
Укажите:
- краткое название: что и где не так;
- описание, а для ошибок — шаги воспроизведения;
- ожидаемое поведение или предлагаемое решение;
- материалы: ссылки, скриншоты, фрагменты текста, источники.
Нажмите Добавить задачу.

Участники проекта рассмотрят задачу и, если нужно, зададут уточняющие вопросы. Когда задачу выполнят, изменения вольются в master и появятся на https://fillis.ru.

Как добавить книгу

Проверьте права. Сканы должны быть из открытого источника (библиотека, архив), а сама книга — в общественном достоянии или в открытом доступе у источника. Запишите название учреждения, ссылку на скан и условия использования.
Создайте каталог книги src/assets/books/<id>/. Идентификатор составляется из языка, короткого названия и года, например fr-principes-1892.
Передайте сканы ссылкой, а не файлами. Сканы и PDF не хранятся в репозитории и не добавляются в Pull Request. Создайте задачу и приложите ссылку на скан у источника или на архив со сканами. Имена сканов — трёхзначный номер страницы по порядку, начиная с 001.jpg: 001.jpg, 002.jpg, … Мейнтейнер выгрузит сканы и PDF в хранилище сайта и добавит в каталог книги манифест media.json (раздел «Медиа книг» в README.md).
Опишите книгу в book.json:
```
{
  "title": "Principes de dressage et d'équitation (1892)",
  "author": "James Fillis, 1834–1913",
  "language": "fr",
  "slug": "principes",
  "year": 1892,
  "pageCount": 530,
  "license": "Public Domain",
  "source": {
    "name": "Bibliothèque nationale de France",
    "url": "https://gallica.bnf.fr/ark:/12148/bpt6k9734367s"
  },
  "toc": [
    { "page": "1", "title": "Обложка" },
    { "page": "17", "title": "PRÉFACE" }
  ]
}
```
Обязательные поля: title, author, language, slug (часть адреса книги: /fr/principes/), pageCount (число сканов), license, source.name и source.url. В toc номер страницы — это номер скана. Необязательное description — описание книги для поисковиков (120–160 символов), если описание по шаблону «Название — книга Джеймса Филлиса: сканы издания…» выходит короче или длиннее.
Добавьте страницы сайта в src/pages/books/<язык>/: описание книги с разделами «Описание», «Лицензия» и «Доступ к книге» и страницу просмотра. Возьмите за образец соседние книги.
Укажите статус и источник. Раздел «Лицензия» в описании книги оформляется так же, как у других книг: статус текста, источник скана со ссылкой, условия источника. Если у источника новые условия, добавьте их в LICENSING.md.

Условия вклада

Код публикуется по лицензии Apache-2.0.
Тексты, переводы и вычитка публикуются по лицензии CC BY 4.0 с указанием вашего авторства.
Присылая материал, вы подтверждаете, что вправе передать его на этих условиях.

Подробности — в LICENSING.md и на странице Лицензии.

Контакты

info@fillis.ru