docs: add guide on forking and update readme structure
This commit is contained in:
committed by
REXNET AI Agent
parent
853ace73e4
commit
61304a3d54
@@ -2,7 +2,7 @@
|
||||
|
||||
Добро пожаловать в официальную документацию платформы REXNET. Этот репозиторий — публичное руководство по внедрению стандартов DevOps и правильной организации работы с кодом.
|
||||
|
||||
Вся информация изложена логично и последовательно: от первоначальной настройки рабочей среды и создания Организации до развёртывания строгих конвейеров. Независимо от вашего уровня, вы сможете легко понять, как выстраиваются процессы в топовых IT-компаниях.
|
||||
Вся информация изложена логично и последовательно: от первоначальной настройки рабочей среды и создания Организации до развёртывания строгих конвейеров. Независимо от вашего уровня, вы сможете легко понять, как выстраиваются процессы в топовых IT-компаниях. Учебник открыт для всех желающих, даже если вы не являетесь сотрудником нашей команды!
|
||||
|
||||
## 🗂 Структура учебника
|
||||
|
||||
@@ -11,17 +11,20 @@
|
||||
* [1.1. Создание Организации и настройка безопасности](docs/beginner/00-organization-setup.md)
|
||||
* [1.2. Матрица доступов: Настройка Команд (Zero Trust)](docs/beginner/00-teams-setup.md)
|
||||
* [1.3. Базовые команды Git: От первого коммита до пуша](docs/beginner/01-git-basics.md)
|
||||
* [1.4. Настройка SSH-ключей (Безопасная авторизация)](docs/beginner/03-ssh-keys.md)
|
||||
|
||||
### 🔵 Модуль 2: Командная разработка (Team Collaboration)
|
||||
Как правильно работать в команде, не ломая чужой код.
|
||||
* [2.1. Feature Branches: Изоляция задач](docs/beginner/02-teamwork.md)
|
||||
* [2.2. Pull Requests: Стандарты Code Review](docs/advanced/00-code-review.md)
|
||||
* [2.2. Open Source: Работа через Форки (Fork)](docs/beginner/04-forking.md)
|
||||
* [2.3. Pull Requests: Стандарты Code Review](docs/advanced/00-code-review.md)
|
||||
|
||||
### 🔴 Модуль 3: Enterprise-Стандарты (DevOps Solutions)
|
||||
Строгие правила REXNET для поддержания качества кода и бесперебойной работы серверов.
|
||||
* [3.1. Архитектура GitFlow и Аппаратная защита веток](docs/advanced/01-gitflow-security.md)
|
||||
* [3.2. Стандарты истории: Conventional Commits, Squash и Rebase](docs/advanced/02-commit-standards.md)
|
||||
* [3.3. CI/CD: Автоматизация процессов и Infrastructure as Code](docs/advanced/03-ci-cd.md)
|
||||
* [3.3. Разрешение конфликтов слияния (Merge Conflicts)](docs/advanced/04-resolving-conflicts.md)
|
||||
* [3.4. CI/CD: Автоматизация процессов и Infrastructure as Code](docs/advanced/03-ci-cd.md)
|
||||
|
||||
---
|
||||
*Мы приветствуем ваш вклад! Ознакомьтесь с [Правилами участия (CONTRIBUTING.md)](CONTRIBUTING.md).*
|
||||
@@ -0,0 +1,33 @@
|
||||
# Open Source: Работа через Форки (Fork)
|
||||
|
||||
Даже если вы не являетесь сотрудником компании или у вас нет прав на запись (`Write`) в основной репозиторий, вы всё равно можете внести свой вклад в развитие открытых проектов. Этот механизм называется **Fork & Pull Request**.
|
||||
|
||||
## 1. Что такое Форк (Fork)?
|
||||
Fork — это создание полной независимой копии чужого репозитория в вашем личном профиле.
|
||||
|
||||
* Зайдите на страницу репозитория (например, `platform-tutorial`).
|
||||
* В правом верхнем углу нажмите кнопку **Fork**.
|
||||
* Система создаст копию по адресу `ваш-логин/platform-tutorial`.
|
||||
|
||||
## 2. Локальная разработка
|
||||
Клонируйте **свой** форк на локальный компьютер, а не оригинальный репозиторий:
|
||||
```bash
|
||||
git clone git@r101.rexnet.cc:ваш-логин/platform-tutorial.git
|
||||
```
|
||||
|
||||
Создайте новую ветку для вашей задачи:
|
||||
```bash
|
||||
git checkout -b docs/add-new-translation
|
||||
```
|
||||
|
||||
Внесите изменения, сделайте коммит и отправьте код в **свой** форк:
|
||||
```bash
|
||||
git push origin docs/add-new-translation
|
||||
```
|
||||
|
||||
## 3. Открытие Pull Request к оригиналу
|
||||
1. Зайдите на страницу вашего форка. Система автоматически заметит, что ваша ветка опережает оригинал, и предложит создать **Pull Request**.
|
||||
2. Убедитесь, что базовая ветка (base) — это `main` оригинального репозитория, а ветка сравнения (compare) — ваша новая ветка из форка.
|
||||
3. Опишите ваши изменения и нажмите **Create Pull Request**.
|
||||
|
||||
Теперь мейнтейнеры (владельцы) оригинального проекта увидят ваш код. Они могут провести ревью, попросить внести правки и, в конечном итоге, слить ваш код в свой главный репозиторий. Вы официально станете контрибьютором!
|
||||
Reference in New Issue
Block a user