diff --git a/.github/docs/en/CONTRIBUTING.md b/.github/docs/en/CONTRIBUTING.md index 567159d..5aa4576 100644 --- a/.github/docs/en/CONTRIBUTING.md +++ b/.github/docs/en/CONTRIBUTING.md @@ -42,17 +42,14 @@ There are many ways to contribute: Ready to make code changes? Great! Here's how to set up your environment. You need Node.js 22 or newer and npm 10 or newer. -**1. Clone the Repository** +**1. Fork and Clone the Repository** -```bash -git clone https://github.com/method-hub/Jext.git -cd Jext -``` - -If you have no write access to `method-hub/Jext`, fork it on GitHub first and push your branch to the fork: +Fork [`method-hub/Jext`](https://github.com/method-hub/Jext) on GitHub first, then clone your fork and add the upstream remote so you can push branches to `origin` and keep `main` in sync with `upstream`: ```bash -git remote add fork https://github.com//Jext.git +git clone https://github.com//Jext.git +cd Jext +git remote add upstream https://github.com/method-hub/Jext.git ``` **2. Install Dependencies** diff --git a/.github/docs/ru/CONTRIBUTING.md b/.github/docs/ru/CONTRIBUTING.md index d2584a4..f0ac071 100644 --- a/.github/docs/ru/CONTRIBUTING.md +++ b/.github/docs/ru/CONTRIBUTING.md @@ -44,17 +44,14 @@ Готовы внести изменения в код? Отлично! Вот как подготовить рабочее окружение. Понадобятся Node.js 22 или новее и npm 10 или новее. -**1. Клонируйте репозиторий** +**1. Сделайте форк и клонируйте репозиторий** -```bash -git clone https://github.com/method-hub/Jext.git -cd Jext -``` - -Если у вас нет прав на запись в `method-hub/Jext`, сначала сделайте форк на GitHub и отправляйте ветку в него: +Сначала сделайте форк [`method-hub/Jext`](https://github.com/method-hub/Jext) на GitHub, затем клонируйте свой форк и добавьте `upstream`, чтобы отправлять ветки в `origin` и синхронизировать `main` с основным репозиторием: ```bash -git remote add fork https://github.com/<ваш-никнейм>/Jext.git +git clone https://github.com/<ваш-никнейм>/Jext.git +cd Jext +git remote add upstream https://github.com/method-hub/Jext.git ``` **2. Установите зависимости** diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ecb32e9..20c97b1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,11 +11,12 @@ performance tests and side-by-side lessons. Write code that is fast and elegant ## Quick start -You need Node.js 22+ and npm 10+. +You need Node.js 22+ and npm 10+. Fork `method-hub/Jext` on GitHub first, then clone your fork and add `upstream`: ```bash -git clone https://github.com/method-hub/Jext.git +git clone https://github.com//Jext.git cd Jext +git remote add upstream https://github.com/method-hub/Jext.git npm ci npm run tests:guardian ```