Skip to content

Latest commit

 

History

History
153 lines (90 loc) · 5.81 KB

CONTRIBUTING.md

File metadata and controls

153 lines (90 loc) · 5.81 KB
Raw

Hikmatlar loyihasiga hissa qo'shish

Hikmatlar loyihasigaga o'z hissangizni qo'shishingizni va uni bugungi kundagidan ham yaxshiroq qilishga yordam berishingizni istardik! Contributorlik uchun quyidagilarga amal qilishni so'raymiz:

Savol yoki muammo bormi?

Savolingizni berishning bir necha yo'li mavjud:

Xavfsizlikda zaiflik topdingizmi?

Agar siz xavfsizlik zaifligini yoki shaxsan muhokama qilinishi kerak bo'lgan narsani topsangiz. Iltimos, biz bilan bog'laning [email protected]

Xato topdingizmi?

Agar manba kodida xato topsangiz, bizga yordam berishingiz mumkin buning uchun bizning GitHub Repositoryga issue yuboring yoki Pull Request muammoni bartaraf etib yuborishingiz ham mumkin.

Imkoniyat yetishmayapti

Siz yangi imkoniyatni so'rashingiz yoki taklif berishingiz mumkin buning uchun Repositoryga issue yuboring. Agar siz yangi funksionalni tadbiq (implement) qilmoqchi bo'lsangiz, muammoni yuboring birinchi navbatda sizning taklifingizni ko'rib chiqib biz undan foydalanishimiz mumkinligiga ishonch hosil qilishimiz kerak.

Iltimos, bu qanday o'zgarish ekanligini ko'rib chiqing:

  • Asosiy xususiyat uchun, avvalo, masalani oching masalani oching va taklifingizni belgilang siz bergan taklif muhokama qilinadi. Bu bizga sa'y-harakatlarimizni yaxshiroq muvofiqlashtirishga, ishlarni takrorlashning oldini olishga va loyihaga muvaffaqiyatli qabul qilinishi uchun o'zgartirishni amalga oshirishga yordam beradi.

  • Kichik xususiyatlar to'g'ridan-to'g'ri ishlab chiqilishi mumkin. Buning uchun Pull Request yuboring.

Taqdim etish boʻyicha koʻrsatmalar (Submission Guidelines)

Muammoni yuborish (Submitting an Issue)

Muammoni yuborishda oldin mavjud bo'lgan muammolar ro'yxatidan tekshirib qarab ko'ring. Siz yubormoqchi bo'lgan muamo ro'yxatda bo'lishi mumkin.

Biz barcha muammolarni imkon qadar tezroq bartaraf etishni xoxlaymiz, lekin xatoni tuzatishdan oldin uni qayta ishlab chiqarishimiz va tasdiqlashimiz kerak. Xatoliklarni tuzatish uchun sizdan muammoni batafsilroq tushuntirishni so'raymiz.

Ushbu formani to'ldirib siz muammo yoki xatolikni yozishingiz mumkin.

Pull Request yuborish Submitting a Pull Request (PR)

Pull Request (PR) yuborishdan oldin quyidagi yo'riqnomaga amal qiling:

  • Pull requests bo'limidan tekshirib ko'ring. Siz yubormoqchi bo'lgan PR mavjud bo'lish mumkin.

  • Barcha o'zgarishlaringizni yangi git branchda qiling

    git checkout -b my-fix-branch main

  • Sizning pull requestingizga tegishli test holatlarni o'z ichiga olishi kerak testlarsiz siz yuborgan PR qabul qilinmaydi.

  • Qilgan o'zgarishlaringizni aniq tavsiflovchi xabarlardan foydalaning bizning xabar konventsiyalarini bajarish qoidalarimizga ergashing. Ushbu konventsiyalarga rioya qilish zarur, chunki relizlar ushbu xabarlardan avtomatik ravishda yaratiladi.

    git commit -a

Eslatma: ixtiyoriy commit -a buyruq qatori opsiyasi tahrirlangan fayllarni avtomatik ravishda qo'shadi add va o'chiradi rm qiladi.

  • Push your branch to GitHub:

    git push origin my-branch

  • Githubda hikmatlar.uz:main ga pull request PR yuboring.

  • Agar biz o'zgarishlarni taklif qilsak

    • Kerakli yangilanishlarni amalga oshiring

    • Qaytadan testlarni ishlatib ko'ring barchasi muvaffaqiyatli o'tishi kerak.

    • Filialingizni qayta asoslang rebase va GitHub omboringizga o'tishga majbur qiling force push (bu sizning Pull Requestingizni yangilaydi):

      git rebase main -i
git push -f

Bo'ldi shu! Hissangiz uchun rahmat!

Pull Request asosiy branchga qo'shilgandan so'ng

Siz yuborgan PR main branchga qo'shilganidan keyin PR uchun yaratilgan branchni Githubdan o'chirib yuborishingiz kerak.

  • Github dan remote branchni o'chirib yuborish uchun quyidagilarga amal qiling:

    git push origin --delete my-branch

  • Check out the master branch:

    git checkout master -f

  • Delete the local branch:

    git branch -D my-branch

  • Update your master with the latest upstream version:

    git pull --ff upstream master

Xabarni yuborish bo'yicha ko'rsatmalar Commit Message Guidelines

Bizning git commit xabarlarimizni formatlash bo'yicha juda aniq qoidalarimiz bor. Ushbu qoidalar loyiha tarixini tushunish va oqishga onson bo'lishi uchun zarur. Lekin biz uchun commit xabarlar o'zgarishlar jurnalini changelog avtomatik generatsiya qilish uchun ham muhim.

Commit xabarlarining formati Commit Message Format

Barcha commit xabarlar header, body, footer. Sarlavha header o'z ichiga olgan maxsus formatga ega ushbu formatlar quidagilar: type va subject.

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Xabarning har qanday satri 100 belgidan oshmasligi kerak! Bu xabarni osonroq qilish imkonini beradi GitHub-da, shuningdek, turli xil git vositalarida o'qish uchun.

Orqaga qaytarish Revert

Agar siz qilgan eng oxirgi commit xabarni ortga qaytarmoqchi bo'lsangiz revert qilishiniz kerak bo'ladi. Ortga qaytarilgan commit

Type

Subject

Body

Footer

Examples