Skip to content

Commit

Permalink
GitBook: [master] one page modified
Browse files Browse the repository at this point in the history
djvnsk authored and gitbook-bot committed May 26, 2019
1 parent c90963f commit cca919c
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -6,13 +6,13 @@

GitBook - это платформа, которая позволяет отображать репозиторий GitHub в виде книги. Вёрстка ведётся в синтаксисе [Markdown](http://www.diy.ru/info/markdown/), хотя на текущий момент это скорее обратная совместимость, но об этом подробнее в разделе [Style Guide](contributing.md#style-guide).

То, что отображается в правой колонке со структурой документа \(оглавление\), задаётся в файле [SUMMARY.md](https://github.com/djvnsk/SDSM/tree/b80a758f7a63c381e6ff27d7f9c674f08e69f143/summary.md). Если редактирование производится в веб-интерфейсе GitBook, SUMMARY.md обновляется автоматически. Однако если ты правишь в текстовом редакторе, то нужно сознательно позаботиться и внести изменения в SUMMARY.md вручную.
То, что отображается в правой колонке со структурой документа \(оглавление\), задаётся в файле [SUMMARY.md](https://github.com/djvnsk/SDSM/tree/b80a758f7a63c381e6ff27d7f9c674f08e69f143/summary.md). Если редактирование производится в веб-интерфейсе GitBook, SUMMARY.md обновляется автоматически. Однако если правки делаются в текстовом редакторе, нужно сознательно позаботиться и внести изменения в SUMMARY.md вручную.

## Pull Request Guidelines

Настало время познакомиться с Git и выбрать инструменты для редактирования. Опытные пользователи могут пропустить этот раздел.

1\. Для начала установите Git.
1. Для начала установите Git.
В **Debian/Ubuntu** в командной строке необходимо выполнить:
`sudo apt-get install git`
В **Fedora**:
@@ -22,11 +22,11 @@ GitBook - это платформа, которая позволяет отоб
`sudo port install git-core +doc +bash_completion +gitweb`
Для **Windows** необходимо скачать [exe-файл инсталлятора](http://msysgit.github.com/) со страницы проекта на GitHub'е и запустить его. После установки будет доступна как консольная, так и графическая версии Git.

2\. Затем зарегистрируйтесь или вспомните свои логин и пароль на [github.com](https://github.com/join?source=login).
2. Затем зарегистрируйтесь или вспомните свои логин и пароль на [github.com](https://github.com/join?source=login).

3\. Создайте **fork** проекта [SDSM](https://github.com/eucariot/SDSM.git). Для этого нужно зайти на страницу проекта [SDSM](https://github.com/eucariot/SDSM.git) и нажать в правом верхнем углу кнопку "Fork".
3. Создайте **fork** проекта [SDSM](https://github.com/eucariot/SDSM.git). Для этого нужно зайти на страницу проекта [SDSM](https://github.com/eucariot/SDSM.git) и нажать в правом верхнем углу кнопку "Fork".

4\. Подготовьтесь к редактированию.
4. Подготовьтесь к редактированию.
Для редактирования в веб-интерфейсе нужно зарегистрироваться \(или войти под учётной записью GitHub\) на [gitbook.com](https://gitbook.com), создать Workspace и импортировать в него свой fork-репозиторий.
Для редактирования в текстовом редакторе нужно сделать локальную копию репозитория. Для этого необходимо создать и перейди в папку, где будет размещаться проект и склонировать репозиторий.
В **\*nix**:
@@ -35,7 +35,7 @@ GitBook - это платформа, которая позволяет отоб
`git clone https://github.com/eucariot/SDSM.git path/to/folder`
В **Windows** всё делается аналогично, только мышкой в GitHub Desktop.

5\. Редактируйте!
5. Редактируйте!
Вы можете вносить изменения в проект с помощью любого удобного инструмента:

* веб-интерфейс gitbook.com;
@@ -45,7 +45,7 @@ GitBook - это платформа, которая позволяет отоб

**Важно:** мы очень рекомендуем править статьи в веб-интерфейсе GitBook. Причин несколько, главная - гитбук автоматически причёсывает синтаксис, следит за оглавлением \(SUMMARY.md\) и лишь обратно совместим с Markdown и GitHub \(например, уже по-другому обрабатывает переносы строк\). Так же в данном проекте решено размещать картинки именно на GitBook. Добавляются они простым копипастом и в таком случае становятся масштабируемыми.

6\. После внесения изменений нужно закоммитить их в свой репозиторий \(**fork** оригинального проекта\).
6. После внесения изменений нужно закоммитить их в свой репозиторий \(**fork** оригинального проекта\).
В **\*nix**:
`git add .` - добавить изменённые файлы, [подробнее](https://git-scm.com/book/ru/v2/Appendix-C%3A-Команды-Git-Основные-команды).
`git commit` - закоммитить изменения в репозиторий, либо [сразу с комментарием](https://git-scm.com/book/ru/v2/Основы-Git-Запись-изменений-в-репозиторий):
@@ -54,7 +54,7 @@ GitBook - это платформа, которая позволяет отоб
[Подробнее](https://guides.github.com/introduction/git-handbook/) о `git push`, ветках и т.п. Ну и в целом, рекомендуется хотя бы пролистать [инструкцию](https://git-scm.com/book/ru/v2) или пройти небольшой интерактивный курс - [раз](https://try.github.io/), [два](https://githowto.com/ru).
В **Windows** всё примерно так же.

7\. Чтобы изменения стали общественным достоянием, а не пылились в вашем форке, нужно создать pull request в оригинальный репозиторий [SDSM](https://github.com/eucariot/SDSM.git). Сделать это можно разными способами, для простоты лучше зайти на страницу своего репозитория на GitHub, выбрать **New pull request**, в качестве источника выбрать ветку в своём репозитории \(если вы не делали лишних движений, то ветка будет одна и это master\), в качестве получателя - master проекта eucariot/SDSM.
7. Чтобы изменения стали общественным достоянием, а не пылились в вашем форке, нужно создать pull request в оригинальный репозиторий [SDSM](https://github.com/eucariot/SDSM.git). Сделать это можно разными способами, для простоты лучше зайти на страницу своего репозитория на GitHub, выбрать **New pull request**, в качестве источника выбрать ветку в своём репозитории \(если вы не делали лишних движений, то ветка будет одна и это master\), в качестве получателя - master проекта eucariot/SDSM.
Проверить вносимые изменения, подтвердить создание pull request.
В качестве комментария указать какие изменения были внесены, желательно писать человекопонятные комментарии, [подробнее](https://git-scm.com/book/ru/v2/Распределенный-Git-Contributing-to-a-Project).

@@ -116,3 +116,4 @@ GitBook автоматически превращает каждый разде
## To-Do list

Нужно определиться с местом хранения списка задач - в [To-Do list](https://github.com/djvnsk/SDSM/tree/2a11b2f5445db77992468e0ee336d06eb2619d2d/TODO.md) или в issues, а так же выставить приоритет. В список задач вы так же можете внести правки, добавить новые пункты или ответственно взять задачу на выполнение.

0 comments on commit cca919c

Please sign in to comment.