mirror of
https://github.com/krahets/hello-algo.git
synced 2026-06-16 23:27:59 +08:00
48 lines
4.9 KiB
Markdown
48 lines
4.9 KiB
Markdown
# Присоединяйтесь к созданию книги
|
||
|
||
Возможности автора ограничены, поэтому в книге неизбежно могут встречаться упущения и ошибки. Просим отнестись к этому с пониманием. Если вы заметите опечатки, неработающие ссылки, пропуски в содержании, двусмысленные формулировки, неясные объяснения или неудачную структуру изложения, пожалуйста, помогите нам это исправить, чтобы читатели получили более качественный учебный ресурс.
|
||
|
||
Все GitHub ID [авторов](https://github.com/krahets/hello-algo/graphs/contributors) будут указаны на главных страницах репозитория книги, веб-версии и PDF-версии в знак благодарности за их бескорыстный вклад в сообщество открытого исходного кода.
|
||
|
||
!!! success "Сила открытого исходного кода"
|
||
|
||
Интервал между двумя тиражами бумажной книги обычно довольно велик, поэтому обновлять содержание очень неудобно.
|
||
|
||
В этой же открытой книге цикл обновления содержания сокращается до нескольких дней, а иногда даже до нескольких часов.
|
||
|
||
### Небольшие правки содержания
|
||
|
||
Как показано на рисунке ниже, в правом верхнем углу каждой страницы есть "значок редактирования". Текст или код можно изменить следующим образом.
|
||
|
||
1. Нажмите на "значок редактирования". Если появится сообщение "You need to fork this repository", согласитесь с этим действием.
|
||
2. Измените содержимое исходного Markdown-файла, проверьте корректность правок и постарайтесь сохранить единый стиль оформления.
|
||
3. Внизу страницы заполните описание изменений, затем нажмите кнопку "Propose file change". После перехода на следующую страницу нажмите кнопку "Create pull request", чтобы отправить pull request.
|
||
|
||
|
||
|
||
Изображения нельзя изменить напрямую, поэтому проблему с ними нужно описывать через новый [Issue](https://github.com/krahets/hello-algo/issues) или комментарий. Мы постараемся как можно быстрее исправить и обновить изображение.
|
||
|
||
### Создание содержания
|
||
|
||
Если вам интересно участвовать в этом проекте с открытым исходным кодом, например переводить код на другие языки программирования или расширять содержание статей, то следует придерживаться следующего процесса Pull Request.
|
||
|
||
1. Войдите в GitHub и сделайте Fork [репозитория книги](https://github.com/krahets/hello-algo) в свой личный аккаунт.
|
||
2. Перейдите на страницу своего Fork-репозитория и с помощью команды `git clone` клонируйте репозиторий локально.
|
||
3. Создавайте и редактируйте содержание локально, затем проведите полное тестирование и проверьте корректность кода.
|
||
4. Зафиксируйте локальные изменения, после чего выполните Push в удаленный репозиторий.
|
||
5. Обновите страницу репозитория и нажмите кнопку "Create pull request", чтобы инициировать pull request.
|
||
|
||
### Развертывание Docker
|
||
|
||
В корневом каталоге `hello-algo` выполните следующий Docker-скрипт, после чего проект станет доступен по адресу `http://localhost:8000`:
|
||
|
||
```shell
|
||
docker-compose up -d
|
||
```
|
||
|
||
Удалить развертывание можно следующей командой:
|
||
|
||
```shell
|
||
docker-compose down
|
||
```
|