Mastering Git: نکات و ترفندهای اساسی برای همکاری کد تمیز

“کد تمیز همیشه به نظر می رسد که توسط کسی که اهمیت می دهد نوشته شده است.” – مایکل پرهای

مقدمه

از طریق تجربه دستی با همکاری در پروژه های منبع باز و توسعه تیم ، من یک گردش کار عملی GIT ایجاد کرده ام که باعث افزایش کیفیت کد و کارآیی تیم می شود. این راهنما درسهای آموخته شده و روشهای خاص را برای حفظ کد های کد تمیز و قابل کنترل به اشتراک می گذارد.

توجه داشته باشید که این برای هر پروژه خاصی نیست بلکه ساخت پروژه های منبع باز است. همچنین ، این مقاله فقط ملزومات Git را در بر می گیرد.

git چیست؟

git توزیع شده است سیستم کنترل نسخه این تغییرات در کد شما را به مرور زمان ردیابی می کند

همکاری در گیت

1. Repo Fork on Github یا ایجاد مخزن برای افراد برای کار کردن

2. یک فضای کد ایجاد کنید

3. همکاران را دعوت کنید

4. به عنوان مالک یک شعبه ایجاد کنید

5. در مورد یک موضوع در مخزن تصمیم بگیرید یا در پروژه یک عضو تیم همکاری کنید

6. همکاران باید از این در GIT استفاده کنند:

   git pull origin 
   

7. برای جلوگیری از ادغام درگیری ها از کد فوق در حد امکان استفاده کنید

8. پس از اتمام تغییراتی در پایان خود:

   git add .         # Stage changes
   git commit -m "message"
   git diff         # view unstaged changes
   
   git log        # view branch logs
   

• توجه: قبل از فشار آوردن به تعهد ، اطمینان حاصل کنید که پیام مشخص است ، در اینجا یک راهنمای کوتاه در مورد نحوه انجام تعهداتی که آموخته ام وجود دارد

• اگر قبلاً پیامی را مرتکب شده اید ، در اینجا نحوه تغییر آن آورده شده است:

git commit --amend -m "New message"

مرتکب نامگذاری کنوانسیون

اساساً 5 بخش وجود دارد که متعهد به برقراری ارتباط به راحتی با مصرف کنندگان کتابخانه است

[optional scope]: [optional body] [optional footer(s)]

• feat – ویژگی جدید

• اشکال – رفع اشکال

• اسناد – تغییر اسناد

• سبک – یک ظاهر طراحی شده که به هیچ وجه روی کد تأثیر نمی گذارد

• Refactor – بدون رفع اشکال یا ویژگی جدید

• پیشرفت های کامل

• تست – تست های کد را انجام دهید

• ساخت – ایجاد سیستم یا تغییر وابستگی خارجی

• پرونده های پیکربندی CI – CI و تغییرات اسکریپت

• کر – پرونده های SRC یا آزمایش را اصلاح نکنید

• می تواند هر چیزی باشد که مکان تغییر تعهد را مشخص کند

• سابق: feat(parser):با fix(database):با docs(readme):

• از Tense ضروری و موجود استفاده کنید: “تغییر” نه “تغییر” و نه “تغییر”

• نامه اول سرمایه گذاری نشده است

• نه “.” در پایان و محدود به 50 کاراکتر

• شامل انگیزه برای تغییر و تضاد با رفتار قبلی است

• تغییر تغییرات باید از آن شروع شود BREAKING CHANGE:

• مسائل نزدیک با Closes #123, #456

• تغییرات بزرگ یا موضوعاتی را که تلاش شده است توصیف کنید

مثال: feat (auth): اجرای احراز هویت JWT

در اینجا دستورات GIT حتی بیشتری وجود دارد که باعث می شود گردش کار شما سریعتر از من استفاده کرده ام یا استفاده کرده ام:

git branch                  # List all branches
git branch     # Create new branch
git checkout   # Switch to branch
git merge      # Merge branches
git stash                   # Temporarily store changes
git stash pop              # Restore stashed changes
git reset --hard HEAD~1     # Undo last commit
git remote -v              # View remote repositories
git restore          # Discard changes in file
git reset --soft HEAD~1    # Undo commit, keep changes staged
git reset --mixed HEAD~1   # Undo commit, unstage changes
git revert         # Create new commit that undoes changes
git tag           # Create lightweight tag
git tag -a  -m "msg"  # Create annotated tag
git push origin       # Push tag to remote
git tag -d        # Delete local tag
git cherry-pick    # Apply commit to current branch
git rebase         # Rebase current branch
git bisect start          # Binary search for bugs
git clean -n              # Show what will be cleaned
git clean -f              # Remove untracked files
git pull origin             # Pulls changes from branch
git push origin             # Pushes changes to branch

بهترین روشها

• اغلب مرتکب شوید

  • حتی با کوچکترین تغییرات ، مانند اضافه کردن متن/دکمه

• مدیریت شعبه

  • برای جلوگیری از درهم و برهمی ، حتماً شاخه ها را حذف کنید

• بررسی کد

  • قبل از ادغام با هم تیمی/دوست قبل از ارتکاب بررسی کنید
  • بازخورد سازنده ارائه دهید
  • مطمئن شوید که هر کسی می تواند آن را بخواند

• مستند سازی

  • بخوانید.
  • کمک کننده. md
  • مراحل نصب/راه اندازی

پایان

git چیزی بیش از یک است سیستم کنترل نسخه – این یک ابزار مشترک است که تیم ها را قادر می سازد تا به طور کارآمد کار کنند و کیفیت کد را حفظ کنند. با دنبال کردن این شیوه ها و درک قابلیت های GIT ، تیم ها می توانند:

• درگیری ها و سردرگمی ها را به حداقل برسانید

• به شما امکان می دهد حتی هنگام کار به صورت جداگانه نسخه ها را علامت گذاری کنید

• تاریخ را حفظ کنید

• توسعه مقیاس

• اشتباهات را بازیابی کنید

• نرم افزار بزرگ را با هم بسازید

به یاد داشته باشید که این شیوه ها باید با نیازهای تیم و نیازهای پروژه شما سازگار باشد. نکته اصلی سازگاری و برقراری ارتباط واضح در تیم است.

آنچه دوست دارم برای برقراری ارتباط استفاده کنم

برنامه نویسی/نوشتن مبارک