diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..87bec4c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,89 @@ + +# Contributing to Parch Linux PKGBUILD Repository + +Thank you for considering contributing to the Parch Linux PKGBUILD repository! Your contributions help improve the community and the software we all use. Please follow the guidelines below to ensure a smooth contribution process. + +## How to Contribute + +1. **Fork the Repository**: Start by forking the repository to your own GitHub account. +2. **Clone Your Fork**: Clone your forked repository to your local machine. + ```bash + git clone https://git.parchlinux.com/packages/pkgbuilds + ``` +3. **Create a Branch**: Create a new branch for your feature or bug fix. + ```bash + git checkout -b my-feature-branch + ``` +4. **Make Changes**: Make your changes to the PKGBUILD or related files. +5. **Commit Your Changes**: Commit your changes with a clear message. + ```bash + git commit -m "Add new package or fix issue" + ``` +6. **Push to Your Fork**: Push your changes to your forked repository. + ```bash + git push origin my-feature-branch + ``` +7. **Create a Pull Request**: Go to the original repository and create a pull request from your branch. + +If you do not wish to create a GitLab account, you can send your changes as a patch file. To create a patch, use the following command: +```bash +git format-patch origin/main +``` +Then, send the generated `.patch` file to the maintainers. + +## Guidelines + +- Ensure that your PKGBUILD follows the Arch Linux packaging standards. +- Test your PKGBUILD before submitting. +- Provide a clear description of your changes in the pull request. + +## Code of Conduct + +Please adhere to the [Code of Conduct](CODE_OF_CONDUCT.md) while contributing to this project. + +--- +‏ + +# مشارکت در مخزن سورس‌های بسته‌های پارچ لینوکس + +از اینکه به مشارکت در مخزن سورس‌های بسته‌های پارچ لینوکس فکر می‌کنید، متشکریم! مشارکت‌های شما به بهبود جامعه و نرم‌افزاری که همه ما استفاده می‌کنیم، کمک می‌کند. لطفاً دستورالعمل‌های زیر را برای اطمینان از یک فرآیند مشارکت روان دنبال کنید. + +## چگونه مشارکت کنیم + +1. **مخزن را Fork کنید**: ابتدا مخزن را به حساب GitHub خود Fork کنید. +2. **Fork خود را Clone کنید**: مخزن Fork شده را به ماشین محلی خود Clone کنید. + ```bash + git clone https://github.com/your-username/parch-linux-pkgbuild.git + ``` +3. **یک شاخه ایجاد کنید**: یک شاخه جدید برای ویژگی یا اصلاح باگ خود ایجاد کنید. + ```bash + git checkout -b my-feature-branch + ``` +4. **تغییرات را اعمال کنید**: تغییرات خود را در PKGBUILD یا فایل‌های مرتبط اعمال کنید. +5. **تغییرات خود را Commit کنید**: تغییرات خود را با یک پیام واضح Commit کنید. + ```bash + git commit -m "اضافه کردن بسته جدید یا اصلاح مشکل" + ``` +6. **به Fork خود Push کنید**: تغییرات خود را به مخزن Fork شده خود Push کنید. + ```bash + git push origin my-feature-branch + ``` +7. **یک Pull Request ایجاد کنید**: به مخزن اصلی بروید و یک Pull Request از شاخه خود ایجاد کنید. + +اگر نمی‌خواهید حساب گیت‌لب ایجاد کنید، می‌توانید تغییرات خود را به صورت فایل patch ارسال کنید. برای ایجاد یک patch، از دستور زیر استفاده کنید: +```bash +git format-patch origin/main +``` +سپس، فایل `.patch` تولید شده را به نگهدارندگان ارسال کنید. + +## دستورالعمل‌ها + +- اطمینان حاصل کنید که PKGBUILD شما با استانداردهای بسته‌بندی Arch Linux مطابقت دارد. +- PKGBUILD خود را قبل از ارسال آزمایش کنید. +- در Pull Request خود توضیح واضحی از تغییرات خود ارائه دهید. + +## کد رفتار + +لطفاً در حین مشارکت در این پروژه به [کد رفتار](CODE_OF_CONDUCT.md) پایبند باشید. + +‏