متنباز
بیشتر ابزارهایی که با آنها کد مینویسی متنبازند و خودت هم میتوانی در ساختنشان سهم داشته باشی. این کلمهها را در صفحهی اول هر مخزن GitHub میبینی.
خواهش مؤدبانه با please
نگهدارندههای پروژههای متنباز غریبههایی هستند که داوطلبانه کار میکنند، برای همین لحن مهم است. جملهی امری با please مؤدبانه میشود: «Please read the README first»، «Please report bugs in the issue tracker». برای درخواست از یک نفر، Could you از آن هم نرمتر است: «Could you review my pull request?». جملهای مثل «Fix this now» بیادبانه است.
هشت کلمهی این درس
open source (اُپن سورس): متنباز؛ نرمافزاری که کد منبعش را همه میتوانند ببینند
open یعنی «باز» و source همان source code است: کد منبع. نرمافزار open source نرمافزاری است که کدش پنهان نیست: هر کسی میتواند آن را بخواند، از آن یاد بگیرد، به کارش ببرد و در بهتر شدنش کمک کند، طبق شرطهایی که مجوزش میگوید. پایتون، لینوکس، Git و VS Code همه متنبازند. بیشتر ابزارهایی که هر روز به کار میبری همینطور ساخته شدهاند.
Python is open source, so anyone can read its code.
پایتون متنباز است، پس هر کسی میتواند کدش را بخواند.
license (لایسِنس): مجوز؛ متنی که میگوید با این کد چه کارهایی مجاز است
license یعنی «مجوز» یا «پروانه»؛ گواهینامهی رانندگی driver's license است. در نرمافزار، license متنی حقوقی است که صاحب کد کنار پروژه میگذارد و میگوید دیگران با آن چه میتوانند بکنند: استفاده، تغییر، فروش، و با چه شرطی. اگر مخزنی license نداشته باشد، یعنی اجازهای داده نشده، حتی اگر کدش را ببینی. معروفها: MIT (خیلی آزاد)، Apache و GPL.
This project is released under the MIT license.
این پروژه با مجوز MIT منتشر شده است.
contributor (کانتریبیوتِر): مشارکتکننده؛ کسی که در یک پروژه سهمی داشته است
contribute یعنی «سهم گذاشتن» و «کمک کردن به یک کار جمعی»؛ contributor کسی است که این کار را کرده. در پروژههای متنباز به هر کسی که چیزی به پروژه اضافه کرده contributor میگویند: یک باگ را درست کرده، یک غلط املایی را در راهنما گرفته، ترجمه کرده یا قابلیتی نوشته. لازم نیست عضو تیم باشی؛ یک پول ریکوئست قبولشده کافی است.
Thanks to all the contributors who helped with this release.
سپاس از همهی مشارکتکنندههایی که در این انتشار کمک کردند.
maintainer (مِینتِینِر): نگهدارنده؛ مسئول اصلی یک پروژه
maintain یعنی «نگهداری کردن»: چیزی را سالم و سرپا نگه داشتن، مثل سرویس مرتب ماشین. maintainer کسی است که مسئول یک پروژه است: پول ریکوئستها را بازبینی و merge میکند، به issueها جواب میدهد، نسخهی تازه منتشر میکند و تصمیم میگیرد پروژه به کدام سمت برود. خیلی از maintainerهای متنباز این کار را داوطلبانه و در وقت آزادشان میکنند؛ با آنها مهربان باش.
A maintainer will review your pull request soon.
یکی از نگهدارندهها بهزودی پول ریکوئست تو را بازبینی میکند.
README (رید می): فایل معرفی پروژه؛ اولین چیزی که باید بخوانی
read me یعنی «من را بخوان». README فایلی است در ریشهی پروژه که خودش از تو میخواهد اول آن را بخوانی: این پروژه چیست، چطور نصب میشود، چطور اجرا میشود و چطور میشود در آن کمک کرد. اسمش را با حروف بزرگ مینویسند تا در فهرست فایلها به چشم بیاید. GitHub این فایل را خودکار در صفحهی اول مخزن نشان میدهد.
Read the README first; it explains how to install the project.
اول README را بخوان؛ توضیح میدهد پروژه چطور نصب میشود.
changelog (چِینجلاگ): فهرست تغییرهای هر نسخه
change یعنی «تغییر» و log یعنی «دفتر ثبت وقایع»: دفتر ثبت تغییرها. changelog فایلی است (معمولا CHANGELOG.md) که برای هر نسخه میگوید چه چیزی اضافه شده، چه چیزی عوض شده و کدام باگها رفع شدهاند، تازهترین بالا. قبل از upgrade کردن یک کتابخانه، نگاهی به changelog بینداز تا غافلگیر نشوی.
Check the changelog to see what is new in this version.
برای دیدن چیزهای تازهی این نسخه، فهرست تغییرها را نگاه کن.
issue tracker (ایشو ترَکِر): سامانهی ثبت و پیگیری باگها و کارها
issue یعنی «مسئله» و track یعنی «رد چیزی را گرفتن»؛ tracker ردگیر است. issue tracker جایی است که باگها، پیشنهادها و کارهای ماندهی یک پروژه در آن ثبت میشود، هر کدام با یک شماره، تا چیزی گم نشود: چه کسی گزارش داده، چه کسی دارد رویش کار میکند، باز است یا بسته. زبانهی Issues در GitHub یک issue tracker است؛ Jira هم یکی دیگر.
Please report bugs in the issue tracker, not by email.
لطفا باگها را در سامانهی پیگیری مسئلهها گزارش کن، نه با ایمیل.
star (اِستار): ستاره؛ نشانهی پسندیدن یک مخزن در گیتهاب
star یعنی «ستاره». در GitHub بالای هر مخزن دکمهای به اسم Star هست؛ وقتی آن را میزنی، هم مخزن را برای خودت نشانهگذاری میکنی تا بعدا راحت پیدایش کنی، هم به سازندههایش میگویی «کارتان را دوست دارم». تعداد ستارهها نشانهی تقریبی محبوبیت یک پروژه است، نه لزوما کیفیتش. فعل هم هست: star the repo.
If you like this project, please give it a star on GitHub.
اگر این پروژه را دوست داری، لطفا در گیتهاب به آن ستاره بده.
صفحهی اول یک پروژهی متنباز
TinyChart is a small open source library for drawing charts in Python.
It is free to use under the MIT license. Please read the README to get started, and check the changelog before you upgrade.
Did you find a bug? Please report it in the issue tracker. Do you want to fix it yourself? Great! Every contributor is welcome. A maintainer will review your pull request within a week.
If you like TinyChart, please give it a star. It helps other people find the project.
TinyChart یک کتابخانهی کوچک متنباز برای کشیدن نمودار در پایتون است.
استفاده از آن با مجوز MIT آزاد است. برای شروع لطفا README را بخوان و قبل از ارتقا فهرست تغییرها را نگاه کن.
باگی پیدا کردی؟ لطفا آن را در سامانهی پیگیری مسئلهها گزارش کن. میخواهی خودت درستش کنی؟ عالی! قدم هر مشارکتکنندهای روی چشم است. یکی از نگهدارندهها تا یک هفته پول ریکوئست تو را بازبینی میکند.
اگر TinyChart را دوست داری، لطفا به آن ستاره بده. این کار کمک میکند دیگران هم پروژه را پیدا کنند.