ممنون بابت وقتی که میزارید برای بهتر کردن PyTse Client. این صفحه شامل راهنمای بهبود پروژه برای کسانی که می‌خواهند در پروژه مشارکت داشته باشند.
ما تلاش می‌کنیم در این پروژه در کنار هم بدون آزرده کردن کسی کار کنیم. هرکس حق مشارکت در پروژه رو دارد و هرکس باید در رفتار احترام داشته باشد و انتقادات سازنده را بپذیرد. هرگونه بی احترامی یا آزار دیگران منجر به حذف شما از شراکت در این نرم افزار می‌شود.
.اگر در هنگام کار با پروژه به مشکلی خوردید لطفا از طریق گیت‌هاب اون رو گزارش کنید می‌توانید آموزش این کار رو در اینجا ببینید GitHub issues.
قبل از درست کردن ایشوی جدید لطفا چک کنید که این موضوع قبلا گزارش نشده باشه لیست مشکلات گزارش شده
برای اینکه مشکلی که گزارش میکنید کیفیت لازم رو برای بررسی داشته باشه لطفا از تمپلیت‌های از پیش ساخته شده استفاده کنید. پس از رفتن به صفحه ایشو‌ها و کلیک روی New issue گزینه گزارش مشکل رو انتخاب کنید و فرم رو پر کنید.
هنگام پر کردن فرم در نظر داشته باشید که:
- توضیحات کافی درباره مشکل بدهید تا بقیه متوجه موضوع بشوند حتی اگر تجربه معاملات بورس ندارند
- درباره‌ی مشکل دقیق باشید مثلا چه دستوری رو در چه شرایطی(سیستم عامل، ورژن پایتون و ورژن پکیج) اجرا کردید و ارور گرفتید
اگر برای بهتر شدن پکیج پیشنهادی دارید مانند مراحل قبل پیش بروید و از تمپلیت پیشنهاد برای بهتر شدن استفاده کنید
قبل از ثبت پیشنهاد پیشنهادات فعلی را چک کنید پیشنهادات فعلی.
نکاتی که بهتر شدن پیشنهاد کمک می‌کنه:
- توضیحات کافی درباره‌ی قابلیت درخواستی طوری که کسی که درباره‌ی بورس اطلاعاتی نداشته باشه متوجه بشه
- استفاده از عکس و url برای توضیح اینکه این دیتا رو از کجا میشه گرفت و محاسبه کرد
اگر دوست دارید در کد نویسی پروژه کمک کنید میتونید اول لیست ایشو هارو ببینید و یک مورد رو انتخاب کنید. معمولا درست کردن باگ‌ها آسون‌تر از اضافه کردن قابلیت هست پس میتونید برای آشنا شدن با پروژه از اینجا شروع کنید: باگ‌ها
برای باز کردن پول ریکوئست میتونید آموزش زیر رو دنبال کنید: https://github.com/firstcontributions/first-contributions/blob/master/translations/README.fa.md
پروژه رو fork کنید و روی دستگاه خودتون clone کنید
git clone https://github.com/<your username>/pytse-client.gitبعد branch خودتون رو بسازید و کد رو اضافه کنید:
git checkout -b mybranch
git push origin mybranchکد پروژه شامل دو بخش مهم download و ticker هست از دانلود برای دریافت دسته جمعی دیتا(batch) استفاده میشه مثلا دریافت معاملات روزانه همه‌ی سهام‌ها و از ticker برای گرفتن اطلاعات خاص یک سهام با توجه به این موضوع میشه فهمید که هر کدی مربوط به کدوم بخش هست. نکاتی که خوبه در نظر داشته باشید:
- همیشه چک کنید آیا کدی که می‌نویسید ممکنه به ارور بخوره؟ اگر اینطور هست این ارور باید چک بشه و پیغام مناسب داده بشه
- حتما چک کنید کدی که اضافه میکنید برای همه‌ی سهام‌ها کار بکنه. مثلا اگر قابلیتی مختص به تعداد خاصی سهام هست حتما توی کد چک کنید که اگر سهام مورد نظر جزو این‌ها نیست ارور نمایش داده بشه
اگر درباره‌ی موضوعی شک دارید یا نیاز به مشورت دارید هیچ مشکلی نیست میتونید توی گروه دیسکورد بپرسید:
