How to contribute to this project | چگونه می‌توان در این پروژه همکاری نمود

[lymanjre]

How to contribute to this project in order to develop a part of this application
چگونه می‌توان در این پروژه همکاری نمود و یک بخش را توسعه داد.

[lymanjre]

for English please translate this response.

برای این کار کافیه شما git را روی سیستم خود نصب نمایید.

نصب git روی سیستم

بر اساس سیستم عامل خود یکی از موارد زیر را باز نمایید.

ویندوز

• ابتدا به اینجا بروید و نسخه مخصوص ویندوز را دانلود کنید.
• سپس فایل دانلود شده را از حالت فشرده خارج نمایید و برای نصب آن را ارا نمایید.

• سپس wizard نصب را تا انتها با next و yes دنبال کنید. پیشنهاد می‌شود تنظیمات دیفالت را تغییر ندهید.

به صورت دیفالت محل نصب git در این مسیر است.

C:/Program Files/Git

یعنی در مراحل بعد، پروژه‌ها در این مسیر قرار می‌گیرند. کار تمام است. - برای چک کردن ورژن `git` نصب شده، `command prompt` را باز نمایید و دستور زیر را اجرا کنید.

git version

• به صورت دیفالت git در پوشه Home کاربر نصب می‌گردد.

مک

• ابتدا از اینجا فایل نصب را دانلود کنید.
• سپس آن را جارا نمایید. نصب خیلی ساده‌ای دارد.
• بعد از نصب برای چک کردن ورژن git نصب شده، terminal را باز نمایید و دستور زیر را اجرا کنید.

git version

لینوکس

در اکثر توزیع‌های سیستم عامل لینوکس git به صورت دیفالت نصب است و نیاز نیست کار خاصی بکنید. اما اگر به هر دلیلی نیاز بود آن را نصب نمایید باید سرچ بزنید و کامند مناسب مربوط به آن توزیع را پیدا کنید. در ادامه کامند نصب مربوط به ند توزیع معروف قرار می‌گیرد.

Debian/Ubuntu

sudo apt-get install git-all

Fedora

dnf install git-all

Arch

pacman -Syu git-all

در همه توزیع‌ها git در مسیر Home کاربر نصب می‌گردد.

• برای چک کردن نسخه git نصب شده در ترمیال این دستور را اجرا کنید.

git version

استفاده از git جهت توسعه پروژه هیدیفای

• ابتدا باید پروژه را fork کنید. برای این کار اگر قصد fork کردن پنل را دارید کامند زیر را اجرا کنید.

git clone https://github.com/hiddify/HiddifyPanel.git

اگر قصد fork کردن hiddify-config را دارید، دستور زیر را اجرا کنید.

git clone https://github.com/hiddify/hiddify-config.git

برای سایر repository ها نیز به همین شکل کافیه که وارد repository شوید و روی Code بزنید و در تب Local آدرس قرار گرفته شده در‌ HTTPS را کپی کنید و در دستور بالا قرار دهید.

• اندکی صبر کنید تا فایل‌های پروژه کپی شود.

• حالا باید یک شاخه یا branch از پروژه درست کنید تا روی آن کار کنید. برای این کار ابتدا برای شاخه یک اسم انتخاب کنید. مثلا فرض کنیم اسم شاخه را Hiddify-develop انتخاب می‌کنیم. حالا دستورات زیر را اجرا کنید.

git branch Hiddify-develop
git checkout Hiddify-develop

• حالا تغییرات مورد نظر خود را روی فایل‌ها با استفاده از هر ابزاری اعمال کنید. توصیه می‌شود از VSCode استفاده نمایید.
• یادتون نره مسیر تمامی فایل‌ها در پوشه‌های گفته شده در مرحله نصب است.
• حالا وقتی تغییرات مورد نظر خود را اعمال نمودید باید تغییرات را در git نیز ثبت کنید. بنابراین در ترمینال کامند‌های زیر را به ترتیب اجرا نمایید.
• ابتدا با کامند زیر انجام تغییرات را به git اعلام کنید.

git add

• سپس تغییرات را کامیت نمایید. نیاز است که در اینجا یک توضیح برای تغییرات اعلام نمایید.

git commit -m "a short description of the change"

مثلا اگر تغییرات مدنظر شما مربوط به بخش توسعه بات باشد می‌توان چنین توضیحی نوشت.

git commit -m "add some features to the telegram bot"

هیچ مشکلی ندارد که توضیحات این بخش زیاد باشد و اتفاقا توصیه می‌شود تا جای ممکن توضیحات کامل و جامع باشد.
در این مرحله تغییرات با موفقیت وارد سیستم git شد. حالا باید تغییرات را به سمت GitHub بفرستید. برای این کار دستور زیر را اجرا کنید.

git push

در اینجا مشخصات اکانت شما در گیتهاب پرسیده می‌شود. نیاز است Username و Password خود در گیتهاب را وارد نمایید.

• حالا وارد اکانت خود در گیتهاب شوید و پروژه فورک شده را باز نمایید.
  مسیری به شکل زیر دارد:

https://github.com/<your_username>/hiddify-config

• حالا یک banner مشاهده می‌کنید که به شما اعلام می‌کند که branch شما از پروژه اصلی یک مرحله جلوتر است. برای اینکه تغییرات با پروژه اصلی merge یا ادغام شود Contribute را کلیک کنید و Open a pull request را بزنید.
• کار تمام است تغییرات به پروژه ارسال شد. حالا پس از تایید مدیر پروژه تغییرات شما به پروژه اضافه می‌گردد.