Bu sayfa, Google Dokümanlar Sezonu için kabul edilen teknik yazı projesinin ayrıntılarını içerir.
Proje özeti
- Açık kaynak kuruluşu:
- SymPy
- Teknik yazar:
- Soumi7
- Proje adı:
- Doküman dizeleri arasında tutarlılık - Sympy dokümanları
- Proje süresi:
- Standart uzunluk (3 ay)
Proje açıklaması
Özet :
Sympy Dokümanlarının Mevcut Durumu ve önceki çalışma :
SymPy için resmi stil kılavuzu oluşturma çalışması tamamlandı.
Lauren Glattly'nin GSoD projesi, SymPy belge dizeleri için bir stil kılavuzu oluşturdu. Bu kılavuza, SymPy Documentation Style Guide'dan (SymPy Belge Stil Kılavuzu) ulaşılabilir.
Özel alt modül ve solvers.py dosyasındaki docstring'ler, yeni stil kılavuzunun yönergelerine uygun olarak düzenlendi
Kod tabanındaki diğer tüm doküman dizeleri de yeni stil kılavuzuna uyacak şekilde düzenlenmelidir.
Önerilen Çalışma :
SymPy'deki çoğu doküman dizesi, hâlâ en son stil kılavuzunu uygulamamaktadır. Bu projenin amacı, SymPy'deki doküman dizelerini bu kılavuza uygun şekilde güncellemektir.
Proje hakkında mentorlarla konuştum. Tartışmanın bağlantısını burada bulabilirsiniz.
Sympy'nin kod tabanındaki doküman dizelerini en son stil kılavuzuna göre düzenlemenin büyük bir iş olduğuna ve projenin bununla sınırlı olması gerektiğine karar verildi.
Projedeki çalışmalarım, mevcut doküman dizelerini güncellemek için yeni kılavuzun uygulanmasını, bir yandan da dil kullanımı veya terimler gibi başka tutarsızlıkların toplanmasını ve ele alınmasını içerir.
Mevcut alt bölümlerin sırası daha sonra değiştirilebilir veya daha sonra ya da ayrı bir görev olarak değiştirilebilir.
Parametreler bölümünün eklenmesiyle birlikte daha fazla örnek ve parametrelere farklı değerler iletildiğinde sonuçlardaki farklılıklar gösterilir.
"Kazalar ve tuzaklar" bölümüne zorlu örnekler eklemeye devam edin.
Katkılar: - #17887 : 17887 numaralı sorun üzerinde çalışıldı: Özel alt modüldeki eksik doküman dizesi bölümlerini ekleyin. L tarafından düzenlenen Spesiyaller alt modülünün bazı işlevlerine eksik Parametreler ve Örnekler bölümünü ekledim. En son stil kılavuzuna göre hareket etmek ve gelecekteki doküman dizeleri için bir model oluşturmak.
Birleştirilmiş halkla ilişkiler adresimin bağlantısı : https://github.com/sympy/sympy/pull/19334
- #19591 : Sorun #19591, Dokümantasyon stil kılavuzunu izler. Core.sympify doküman dizesini en son stil kılavuzuna uyacak şekilde düzenlemek için bir PR ekledim. Farklı parametrelerin kullanımıyla ilgili yapılandırılmış açıklamalar ve örnekler ekledim.
Halkla İlişkiler sitesine şu bağlantıdan erişebilirsiniz: https://github.com/sympy/sympy/pull/19613
Proje Hedefleri
Zaman Çizelgesi 17 Ağustos'tan önce :
- Kuruluşa katkıda bulunmaya devam edin.
- Kullanıcı belgeleri ve sympy'nin güncel sürümü hakkında daha fazla bilgi edinin.
- Projeyi uygularken yardımcı olacak teknikleri ve becerileri öğrenmek.
Topluluk bağları : (17 Ağustos - 13 Eylül 2020)
- Saat farkı nedeniyle, bir iletişim kanalı ve saat ayarlayın.
- Hedeflerimi hassaslaştır ve her iki tarafta da beklentilerimi belirley.
- Modüllerin güncelleneceği sırayı tartışma.
- Düzenleme modüllerini sıraya ekleyerek en son doküman dizesi stil kılavuzuna uymalarını sağlayın.
Dokümantasyon dönemi(14 Eylül 2020 - 30 Kasım 2020) :
Her hafta ulaşmak istediğiniz hedefler belirleyin. Tercihen haftada bir veya daha fazla modülün ya da alt modülün doküman dizelerini güncelleyin.
Tüm bu modüllerde birincil hedefim eksik bölümleri eklemek ve doküman dizelerini en son stil kılavuzuna göre yeniden yapılandırmak. Bu, parametrelere farklı değerler geçirildiğinde elde edilen farklı sonuçların gösterilmesini de içerir. Tüm dikkat çekici çıktılar, Gotchalar ve Tuzaklar bölümüne eklenmelidir.
1. Hafta ( 14 Eylül - 21 Eylül) : Temel
2. Hafta (22 Eylül - 29 Eylül) : İşlevler : Alt Modüller Kombinasyonal
3. Hafta (30 Eylül - 6 Ekim) : İşlevler
4. Hafta (7 Ekim - 14 Ekim) : Basitleştirme, Kripto
5. Hafta (15 Ekim - 21 Ekim) : Diyofantus
6. Hafta (22 Ekim - 29 Ekim):Holonomi :Operasyonlar alt modülü
7. Hafta (30 Ekim - 7 Kasım) : İntegrals Modülü(integrals.integrals), Meijer G Fonksiyonlarını Kullanarak İntegral Hesaplama
8. Hafta (8 Kasım - 15 Kasım) : Fizik, Kategoriler Modülünün sonundaki işlevler, Kod Oluşturma Modülü, Alt Modül Özel
9. Hafta (16 Kasım - 23 Kasım) : Fizik, Kategoriler Modülünün sonundaki işlevler, Kod Oluşturma Modülü, Alt Modül Özel
10. Hafta (24 Kasım - 30 Kasım) : Gotcha'lar ve Tuzaklar bölümü
30 Kasım - 5 Aralık 2020, 18:00 UTC : Nihai Proje gönderimi ve Rapor Yazma
3-10 Aralık 2020, 18:00 UTC : Projenin başarısı ve mentorlarla çalışma deneyimi
Burada bahsedilen modüllerin sırası, mentorlarla yaptığımız görüşmelerden sonra değiştirilebilir.
Mentorların tavsiye ettiği gibi, öncelikle güncellenmesi daha kolay olan bu modülleri güncellemeye odaklanacağım. Daha sonra karmaşık olanlara geçeceğim.
Neden bu proje için doğru kişiyim?
Bilgisayar Bilimleri ile ilgili teknik yazı yazma konusunda geçmişte deneyime sahip olduğum ve git ile github'ı çok iyi bildiğim için bu proje için doğru kişi olduğuma inanıyorum.
Belgeleri, başarılı bir şekilde birleştirilen Sympy'deki en son stil kılavuzuna güncellemek üzere halkla ilişkiler ekibini gönderdiğim için, iş akışı ve düzenli katkılar konusunda kendime güveniyorum.
Katkıda bulunmaya başladığımda başlangıçta bazı hatalarla karşılaştım. Sonunda alıştığım testlere ve dokümanları oluşturmaya alıştım ve bu sayede değişiklikleri uygulamadan önce her seferinde bu çok önemli hale geldi.
Bu projeye katkıda bulunma konusunda çok rahatım ve sabırsızlanıyorum.