Skip to content

Latest commit

 

History

History
78 lines (61 loc) · 4.28 KB

CONTRIBUTING.md

File metadata and controls

78 lines (61 loc) · 4.28 KB

Правила

Пожалуйста, не добавляйте в данную базу знаний новые темы/шпаргалки/файлы. Если вас интересует emacs или что-то подобное (то что не освещено здесь), вы можете создать свою личную заметку. Делайте вклад если заметили в конкретном описании notes какие-то опечатки (очепятки), или ошибки в инструкциях/командах/программах, какие-то неточности. Например, вы можете не согласиться с описанием работы памяти в Linux и предложить свою версию, более подробную и с примерами (вместе ссылкой на источник в коммите, чтобы это выглядело аргументировано) или может быть вы захотите дополнить текущие темы. Копировать сюда весь интернет тоже не нужно =) Здесь собраны короткие и простые описания, которые могут быть полезны при беглом чтении системному администратору, программисту, сопровождающему пакетов, тестировщику и любому другому Linux инженеру. Спасибо, что посетили этот файл.

Пример текста:

Фильтры определяют, какие строки в логах будут отслеживаться.
Обычно файл фильтра для sshd уже существует и находится по пути
`/etc/fail2ban/filter.d/sshd.conf`. Убедитесь, что он содержит правила
для обнаружения ошибок, подобных тем, что вы видите в журналах.
  • Длина строки сплошного текста не должна превышать 80 символов +-, в vim можно добавить:
set textwidth=80
  • Пути, Shell команды и в необходимых случаях, можно обозначать символами ``:
Команда `ls -l /`
Путь к `/path/to/directory`
Переменная `PATH` бывает ...
Нужно нажать клавишу `e` и затем ...
и т.д.

Участие

Если вы хотите внести свой вклад в notes, пожалуйста, следуйте этим простым правилам:

  1. Сделайте Fork проекта.

  2. Склонируйте репозиторий из вашего аккаунта с помощью команды:

    $ git clone [email protected]:<username>/notes.git

  3. Создайте новую ветку:

    git checkout -b "notes-1-fix"

    Вы можете назвать ветку как хотите.

  4. Сделайте изменения.

  5. Не забудьте добавить себя в contributors.md в формате:

    * [username](https://github.com/<username>)

  6. Сделайте коммит с подробным описанием изменений, можно указать статью/ссылку на материал в коммите.

  7. Отправьте коммит, а затем сделайте Pull Request в GitHub.

Важно

Пожалуйста, не забудьте обновить ваш форк. В то время как вы сделали изменения, содержимое ветки master может измениться, потому что произошло слияние других Pull Resuest'ов, и это может привести к конфликтам. Вот почему вы должны сделать rebase master каждый раз перед нажатием изменений и убедиться, что ваша ветка не имеет никаких конфликтов с master.

Спасибо.