2.0 KiB
2.0 KiB
Правила участия в проекте (Contributing Guidelines)
Мы рады любой помощи в развитии нашего открытого учебника! Чтобы процесс был удобным для всех, пожалуйста, следуйте этим простым правилам.
Как предложить изменения
- Создайте Issue (Задачу): Если вы нашли ошибку или хотите предложить новую главу, сначала создайте Issue. Опишите, что именно вы хотите изменить.
- Форкните репозиторий (Fork): Сделайте копию репозитория в свой аккаунт с помощью кнопки "Fork".
- Создайте новую ветку: Никогда не вносите изменения в
main. Создайте ветку:git checkout -b docs/new-chapter. - Внесите изменения: Убедитесь, что вы используете правильное форматирование Markdown и пишете на грамотном русском языке.
- Сделайте коммит (Commit): Сообщения коммитов пишите строго на английском языке, кратко и по делу. Пример:
docs: fix typo in introductionилиfeat: add chapter about SSH keys. - Откройте Pull Request (PR): Отправьте ваши изменения в наш главный репозиторий.
Стандарты оформления
- Используйте заголовки для логического разделения текста.
- Выделяйте системные команды обратными кавычками:
git status. - Будьте вежливы при обсуждении кода коллег.
Спасибо за ваш вклад в развитие open-source!