کمک به جمی
مشارکت به Jami همیشه خوش آمدید و بسیار قدردانی می شود. راه های زیادی برای کمک به Jami وجود دارد، از جمله گزارش اشکال و مسائل، کمک به کد، کمک به بسته بندی و نگهداری Jami برای توزیع GNU / Linux یا سیستم عامل دیگر، و همچنین کمک به خود این اسناد.
لطفاً در زیر ببینید که چگونه شروع به کمک به Jami کنید!
گزارش خطاها و مسائل
لطفا در راهنمای گزارش حشرات برای دستورالعمل های مرحله به مرحله در مورد چگونگی گزارش اشکال و مشکلات شما در Jami را ببینید.
کد کمک
تمام
بسته بندی Jami
تمام
کمک به این اسناد
مشارکت در این اسناد همیشه از نظر کوچک تا فصل های جدید مورد استقبال و قدردانی قرار می گیرد.
این صفحه مراحل ایجاد یک صفحه جدید یا ارسال یک تصحیح را طی می کند. روند بررسی پیچ همان عمل است که برای هر پروژه دیگر Jami انجام می شود. بنابراین ما هر دستور را توضیح نخواهیم داد.
توجه
با کمک به این اسناد، شما موافقت می کنید که کمک های خود را تحت نسخه:doc:fdl، نسخه 1.3 یا هر نسخه بعدی منتشر شده توسط بنیاد نرم افزار آزاد، بدون بخش های غیر متغیر، بدون متن های پوشش پیش و بدون متن های پوشش عقب، در دسترس قرار دهید.
شما همچنین قول می دهید که شما نویسنده ی تغییرات خود هستید یا که آنها را از یک اثر در حوزه عمومی یا اثر منتشر شده تحت مجوز رایگان که با GNU Free Documentation License سازگار است کپی کرده اید.
TODO: بین المللی شدن
وابستگی ها
شما نیاز به Git نصب و پیکربندی شده برای استفاده از کلید SSH خود را، و یک حساب در Jami Gerrit، که شما می توانید پیچ های خود را برای بررسی ارسال. اگر شما نیاز به کمک با این، ببینید:doc:` آغاز ما پیچ ارسال راهنمای <how-to-submit-a-patch>` (TODO).
اگر می خواهید تغییرات خود را در وب مرورگر خود پیش نمایش کنید، باید Sphinx، Read the Docs Sphinx theme، و MyST Markdown parser را نصب کنید.
$ pip install --upgrade sphinx sphinx_rtd_theme myst_parser
اگر می خواهید از ویژگی ساخت خودکار و تجدید خودکار استفاده کنید، همچنین sphinx-autobuild را نصب کنید.
$ pip install --upgrade sphinx-autobuild
کلون کردن مخزن
کلون مخزن و تنظیم تنظیمات فشار را به این شکل:
$ git clone "ssh://USERNAME@review.jami.net:29420/jami-docs.git"
$ cd jami-docs
$ git config remote.origin.push HEAD:refs/for/master
شما ممکن است بخواهید قبل از اینکه هرگونه تغییر در پرونده ها را انجام دهید، برای هر سهم/تبدیل یک شاخه جدید را چک کنید، تا بتوانید به راحتی git pull
هر تغییر آینده را از جریان بالا به شاخه اصلی محلی خود منتقل کنید:
$ git checkout -b my-example-change
ویرایش یک صفحه
صفحات به صورت نشان داده شده یا reStructuredText نوشته می شوند. شما می توانید روی "دید منبع صفحه" در بالای هر صفحه کلیک کنید تا منبع خام صفحه را باز کنید و ببینید که چگونه نوشته شده است.
ادامه دهید و تغییرات خود را به فایل های .rst
یا .md
انجام دهید.
بررسی کار شما
از پایه مخزن، اجرا کنید:
$ make clean && make html
شما باید اکنون بتوانید اسناد را در مرورگر وب خود مشاهده کنید. صفحه اصلی در ``_build/html/index.html`.
توجه
This documentation does not currently build with the latest version of sphinx. Please see this issue on GitLab for a workaround and updates regarding this problem.
برای ایجاد خودکار اسناد و تازه کردن مرورگر وب شما هر بار که تغییرات را ذخیره کنید، اجرا کنید:
$ make clean && make watch
این را در پس زمینه اجرا کنید، سپس به http://127.0.0.1:8000 بروید (نه فایل.html محلی).
نجات کارتون
$ git add source/file/you/edited.md
$ git commit
پيام تعهدات شما بايد اينطوري باشه:
Short summary of your change in present tense
Longer description of your change in complete sentences, if necessary.
Jami GitLab issue numbers (e.g. GitLab: #445), if relevant.
مثلاً:
Add new page section to contribute guide
Add a new section explaining how to add a new page to these docs,
including listing it in the `toctree` directive of the containing
section/folder index.
GitLab: #123
ارسال یک تغییر
اولین بار که سعی می کنید تغییرات خود را فشار دهید، گریت شکایت می کند که شما یک تغییر شناسه در تعهد خود ندارید و یک دستور scp
را برای نصب خط تعهد ارائه می دهد. پس از اجرای دستور، شما باید بتوانید تغییر خود را دوباره انجام دهید و فشار دهید:
$ git commit --amend --no-edit
$ git push
تغییر کاری که انجام می دهید
یک بازرس ممکن است از شما بخواهد قبل از ترکیب آن تغییراتی در پیوند خود ایجاد کنید. این مشکلی نیست! فقط تغییراتی را انجام دهید، git add`
آنها را انجام دهید و git commit را اجرا کنید تا پیوند را تغییر دهید. توجه به سوئیچ ``-amend
, که برای گفتن به git که amend/tweak جدیدترین تعهد موجود را به جای انجام یک تعهد جدید انجام دهد. این جریان کار برای بروزرسانی تغییر پیشنهادی هنگام استفاده از Gerrit است.
اضافه کردن یک صفحه
اگر تصمیم بگیرید که یک صفحه جدید به اسناد اضافه کنید، باید آن را به دستورالعمل toctree
در آن فصل اضافه کنید.
به عنوان مثال، اگر یک صفحه جدید به نام hosting-jams-on-aws-guide.md
در دستور کار کاربر Jami در پوشه user
اضافه کردید، باید آن را در دستورالعمل toctree
از user/index.rst
، بدون تمدید فایل اضافه کنید:
.. toctree::
...
bug-report-guide
hosting-jams-on-aws-guide