Bu sayfada, Google Dokümanlar Sezonu için kabul edilen bir teknik yazım projesinin ayrıntıları yer almaktadır.
Proje özeti
- Açık kaynak kuruluşu:
- MicroPython
- Teknik yazar:
- Joannah Nanjekye
- Proje adı:
- MicroPython'un iç yapısını belgeleme
- Proje uzunluğu:
- Standart uzunluk (3 ay)
Proje açıklaması
Soyut
MicroPython, Python programlama dilinin alternatif bir uygulamasıdır. Çoğunlukla Python 3.4 ile uyumlu olması amaçlanmıştır ancak özellikle veri türleri ve modüller olmak üzere işlevlerin bir alt kümesine sahiptir. MicroPython, mikrodenetleyicilerde ve kaynak sınırlı ortamlarda yalın ve verimli bir şekilde çalışır [1]. Açık kaynaklı olan bu proje, zaman içinde birçok kullanıcı ve katkıda bulunan kişi tarafından ilgi gördü. Projeyi belgelemek, hem kullanıcı sayısında hem de yeni özelliklerle katkıda bulunanlarda daha fazla büyüme sağlar. MicroPython'a katkıda bulunmak genellikle çekirdek çalışma süresi üzerinde çalışmayı, yeni bir panoya/işletim sistemine taşımayı veya yeni bir kitaplığın bakımını yapmayı içerir. Bu teklif, MicroPython projesinin iç işleyişine dair belgelere odaklanır. Ana temalar, yorumlayıcının iç işleyiş şekli, dili yeni bir platforma taşıma ve yeni bir modül oluşturmadır.
Proje Bilgileri
Projenin amacı, mevcut docs.micropython.org sitesine MicroPython'un iç işleyişine dair dokümanlar eklemektir. Bunu Internals.micropython.org adresine de taşıyabiliriz. Mentorlardan biri olan Jim Mussared, topluluk geri bildirimlerinden bu dokümanları "geliştirme" bölümüne taşımamızı önerdi. Amaç, MicroPython'un ayrıntılarını MicroPython'un uygulanması üzerinde çalışan bir geliştiricinin bakış açısından ele almaktır. Bu sayede projeye katılmak isteyen herkes için kolay bir katkı eğrisi elde edebilirsiniz.