parch-profiler/CONTRIBUTING.md
2024-08-20 15:37:46 +00:00

3.4 KiB
Raw Permalink Blame History

🛠️ Contributing to Parch-Profiler

We welcome contributions to Parch-Profiler! Whether you want to add new features, fix bugs, improve documentation, or suggest new ideas, your help is appreciated.

📥 How to Contribute

1. Fork the Repository

Start by forking the repository on GitLab. This will create a copy of the project under your GitLab account.

2. Create a Branch

Create a new branch for your work:

git checkout -b my-feature-branch

3. Make Your Changes

Make the necessary changes in your branch.

4. Commit Your Changes

Write clear and concise commit messages:

git commit -m "Add feature XYZ"

5. Push to Your Fork

Push your changes to your forked repository:

git push origin my-feature-branch

6. Create a Merge Request (MR)

Go to your forked repository on GitLab and create a Merge Request (MR) against the main branch of the original repository.

7. Review Process

Your MR will be reviewed by the maintainers. If any changes are required, please address the feedback and update your MR.

8. Submit a Git Patch (Optional)

Alternatively, you can submit your contribution as a Git patch via email:

  • Generate the patch:
    git format-patch origin/main
    
  • Send the patch to: behdanisohrab@riseup.net

🛠️ مشارکت در Parch-Profiler

ما از هرگونه مشارکت در پروژه Parch-Profiler استقبال می‌کنیم! اگر می‌خواهید ویژگی‌های جدیدی اضافه کنید، اشکالات را رفع کنید، مستندات را بهبود ببخشید یا ایده‌های جدید پیشنهاد دهید، کمک شما ارزشمند است.

📥 نحوه مشارکت

1. پروژه را انشعاب بگیرید

ابتدا پروژه را در گیت‌لب انشعاب بگیرید/. این کار یک کپی از پروژه را تحت حساب گیت‌لب شما ایجاد می‌کند.

2. یک شاخه جدید ایجاد کنید

یک شاخه جدید برای تغییرات خود ایجاد کنید:

git checkout -b my-feature-branch

3. تغییرات خود را اعمال کنید

تغییرات لازم را در شاخه جدید خود انجام دهید.

4. تغییرات خود را Commit کنید

پیام‌های commit واضح و مختصر بنویسید:

git commit -m "اضافه کردن ویژگی XYZ"

5. تغییرات را به انشعاب خود ارسال کنید

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

git push origin my-feature-branch

6. درخواست ادغام (MR) ایجاد کنید

به مخزن انشعاب شده خود در گیت‌لب بروید و یک درخواست ادغام (MR) به شاخه اصلی مخزن اصلی پروژه ایجاد کنید.

7. فرآیند بررسی

درخواست MR شما توسط نگهداران پروژه بررسی خواهد شد. اگر نیاز به تغییرات بود، لطفاً بازخوردها را اعمال کنید و MR خود را به‌روزرسانی کنید.

8. ارسال پچ Git (اختیاری)

همچنین می‌توانید تغییرات خود را به صورت پچ Git از طریق ایمیل ارسال کنید:

  • پچ را ایجاد کنید:
    git format-patch origin/main
    
  • پچ را به آدرس behdanisohrab@riseup.net ارسال کنید.