moja global projesi

Bu sayfa, Google Dokümanlar Sezonu için kabul edilen bir teknik yazı projesinin ayrıntılarını içerir.

Proje özeti

Açık kaynak kuruluşu:

moja global

Teknik yazar:

Tlazypanda

Projenin adı:

FLINT için Teknik İlk Katılım Kılavuzu Dokümanları

Proje süresi:

Standart uzunluk (3 ay)

Proje açıklaması

Yeni katkıda bulunanların destekleyicilerden minimum destekle kolayca başlayabilmesi için yeni katkıda bulunanlara teknik oryantasyon yoluyla rehberlik etme amacıyla FLINT için Teknik İlk Katılım Kılavuzu belgesi.

Proje Sorunları

Mevcut dokümanlarla ilgili en önemli sorunların listesi aşağıda verilmiştir: - Yerel kurulum kılavuzu talimatlarının düzensiz bazı bölümleri, bu nedenle yeni katkıda bulunanların çalışmaya başlamasını zorlaştırabilir. - Birden fazla FLINT deposunun amacına dair belgeler bulunmuyor ve birbirlerine bağlı değiller. Bu da yeni başlayanların hangi deponun kurulacağını belirlemesini zorlaştırıyor. - Windows kurulumu iyi belgelenmiştir ancak Linux tabanlı yükleme belgelerinde bazı iyileştirme yapılabilir. - Git iş akışı şu anda bu belgenin bir parçası değildir

Önerilen Çözüm

Bu öneri, yeni katkıda bulunanlara teknik ilk katılım sırasında rehberlik edecek bir çözüm sunar. Böylece yeni katkıda bulunanlar, bakım görevlilerinden minimum destekle kolayca başlayabilir. Bunu yeni başlayanlara uygun hale getirecek şekilde mevcut belgeleri yeniden düzenleyerek ve ayrıca tüm belgeler için merkezi ve bağımsız bir veri deposuna sahip olabilirsiniz. Proje üç aşamadan oluşmaktadır:- - Mevcut belgeleri gözden geçirme ve yeniden düzenleme: Bu aşamanın amacı mevcut kılavuzu gözden geçirmek ve yeni katkıda bulunanlar tarafından kolayca anlaşılabilecek ve kısa ve öz olacak şekilde yeniden düzenlemektir. Ayrıca, dokümanları yeni başlayanlara uygun hale getirmek için rozetlerin, emojilerin ve yalnızca ilk kez kullananlar ya da ilk sorun etiketleriyle etiketlenmiş sorunlarla ilgili bilgiler eklenerek düzenlenmelidir. - Merkezi, bağımsız bir belge deposu oluşturma: Bu aşamanın amacı, mevcut tüm belgeleri mantıksal ve sıralı olarak bağımsız bir depoya bağlamaktır. Bu adım, katkı yönergelerini, proje hazırlama talimatlarını ve adım adım açıklamalı kılavuzları sıralamayı içerir. - Yeni geliştiriciler için Geliştirici iş akışı ve topluluk web sitesi ekleme: Bu aşamanın amacı, test ve KG yönergeleriyle birlikte projenin teknoloji mimarisini ve git katkı yönergelerini içeren Geliştirici iş akışını eklemektir. Önerilen topluluk web sitesi, iş akışını, yeni katkıda bulunanlar tarafından talep edilebilecek ilk kez katılımcı sorunlarını ve tüm katkıda bulunanların listesini görüntüleyen tek sayfalık bir uygulama olacaktır. 1. Aşama: Mevcut belgeleri inceleyin ve yeniden düzenleme yapın:

Aşağıdaki depoların mevcut belgelerini değiştirin: - FLINT: Mevcut dokümanlar çok ayrıntılı değil ve gerekli ön koşul kitaplıklarının sıralı sırasını sağlamıyor. Adım adım açıklamalı talimat kılavuzları farklı pdf'lere bölünmüştür ancak tek bir yerde daha kısa ve öz bir şekilde birleştirilebilir. Ayrıca, yükleme kılavuzları pencerelere göre sağlanır, ancak Linux kurulumu için FLINT.docker deposuna yönlendirme yapmak yararlı olabilir. - FLINT.docker: Mevcut dokümanlar, bu kod deposunun ayarlanmasındaki amacı, yani FLINT'in docker üzerinden Linux kurulumunu sağlamak amacını belirtmiyor. Docker desteği yalnızca Ubuntu 18.04 (Bionic Beaver) ile sınırlıdır, ancak diğer Linux tabanlı dağıtımlarda da kullanılabilir. Mevcut dokümanlarda Docker dosyalarının sıralı bir şekilde ayarlanma şekline ve ayrıca, makefile dosyasından nasıl derleneceğine dair yeterli bilgiye yer verilmesi gerekir. - FLINT.örnek: Mevcut dokümanlar bu depoyu ayarlama amacını açıklamıyor. Burada amaç, FLINT'in nasıl kullanılacağına dair bir örnek sunmaktır. Farklı örnek çalıştırmalar, çalıştırılmaları için özel talimatlarla daha iyi ayrılabilir. Ayrıca, bu kod deposunu ana FLINT depomuza bağlamamız gerekiyor. Bu şekilde, kullanıcılara örneği uygulamadaki örneği görebilmeleri için bir yöntem sunulmalıdır.

Şu bilgilerin mevcut dokümanlara eklenmesi gerekiyor: - Git ve GitHub kullanımı: Bu bilgiler arasında, çatallama, klonlama ve depo için uzak yukarı akış ayarlama ile ilgili adım adım talimatlar yer alır. Ayrıca en son ana kopyaya göre yeniden baz alma ve birleştirme çakışmalarının nasıl ele alınacağı hakkında bilgi de verilir. - Rozetler ve Emoji'ler: Mevcut dokümanlarda, yeni katkıda bulunanların iyi karşılandığını hissetmelerine ve sorunları daha az göz korkutucu bulmalarına yardımcı olabilecek Rozetler ve Emojiler yoktur. - İlk Kronometreler/Yeni Başlayanlara Uygun sorunlar hakkında bilgi: Bu bilgi, yeni katkıda bulunanları yeni başlayanlara uygun sorunlara ve topluluk web sitesine yönlendirmeye yardımcı olur. - Import-me deposu hakkında bilgi: Import-me deposu, herhangi bir Moja Global deposunu başlatmak için temel şablon görevi görür. Mevcut dokümanlarda bunun öneminden bahsedilmiyor. Burada Import-me deposundan bahsedilerek güncellenmesi gerekir. Ayrıca, yeni depo oluşturmak için bu depoyu şablon olarak seçme adımları da eklenmelidir. Ayrıca, kodlayıcıların Import-me deposu için ek özellikler önermeleri için oluşturulmuş bir süreç de olmalıdır.

2. Aşama: Merkezi ve bağımsız bir belge deposu oluşturma :

Barındırma platformu için kullanılacak araç:

Bu barındırma platformu için önerilen araçlar, şu nedenlerden dolayı Dokümanları Oku'dur:- - Farklı barındırma platformları arasında üst sıralarda olmalıdır. - Kaydetme işleminde otomatik güncelleme - Çok sayıda kullanıcı tarafından kullanıldığı için kolayca ayarlanıp sorun giderme desteği sunulur - Belgeler reStructuredText kullanılarak biçimlendirilir ve çıktı, Sphinx tarafından derlenir.

Tüm içeriği mantıksal olarak sıralı bir şekilde düzenleyin:

Önerilen içerik sırası şu şekildedir:- - Geliştirici belgelerine giriş: Bu bölümde Moja Global ve FLINT tanıtımlarını ele alacağız. - Katkıda Bulunma: Bu bölüm "Katkıda bulunma Yöntemleri" (kod/raporlama hataları/çeviri/dokümanlar/etkinlik düzenleme vb. açısından) ve "Davranış Kuralları" alt bölümlerinden oluşacaktır. - Geliştirme Kuralları: Bu bölümde "Git ve GitHub İş Akışı", "Windows Kurulumu", "Linux Kurulumu" alt bölümleri yer alacaktır. İstekte bulunan Geliştirici İş Akışı, bir sonraki belge testi için nasıl test edileceğini ve bir sonraki entegre test aşamasında nasıl test edileceğini belirleyebilirsiniz. - Bize katılın: Bu bölümde Moja Global ile bağlantı kurmak ve çalışmak için kullanabileceğiniz Slack kanalları gibi çeşitli sosyal forumlar bulunur.

3. Aşama: Yeni katkıda bulunanlar için geliştirici iş akışı ve topluluk web sitesi ekleyin:

Geliştirici İş Akışı Belgeleri:

Geliştirici iş akışı belgeleri aşağıdaki alt bölümlerden oluşur:

• Kullanılan Teknoloji Yığını/Mimari ve koddaki çeşitli modüller: Teknoloji yığınının uygulandığı, yeni katkıda bulunanları tanımaya yönelik belgeler, kod tabanının çeşitli kitaplıkları ve modülleri.
• Entegre test ve kapsam araçları: Test için kullanılan CI/CD ardışık düzen araçlarına katkıda bulunanları yeni kullanıcılar, Kapsam botları ve Otomatik Kalite Kontrolleri kodlarına göre çalıştırın. Ayrıca testlerin başarısız olması durumunda kime yaklaşmaları gerektiği konusunda yönergeler sunarak.
• İş akışını kolaylaştırmak için kullanılan botlar. Ör. Zulipbot: Bot'ların görüntülenmesi için içerik şablonları tasarlama ve kullanıcıların botları anlamasına, hatta katkıda bulunarak bot yapılandırmasını geliştirmesine olanak tanımak için dokümanlara erişim.
• Bir pull isteğinin manuel olarak test edilmesi ve gönderilmesi: Çekme isteklerinin belirli standartlara göre manuel olarak test edilmesi ve Çekme İsteklerinin gönderilmesiyle ilgili ekran görüntüleri/gifler açısından sonuçların yüklenmesi hakkında sağlanan belgeler.
• Katkıda bulunanlar tarafından uyulacak çekme isteği inceleme kuralları: Bakım yapanların yanıt vermesine olanak tanımak için belirli ekipleri inceleme için etiketleme ve çekme isteğine "inceleme gerekiyor" gibi etiketler eklemeyle ilgili yönergeler.

Topluluk Web Sitesi:

Topluluk web sitesi aşağıdaki özelliklere sahip olacaktır:-

• İş Akışımızla ilgili bilgiler: İş akışı, yeni bir katkıda bulunan kullanıcının başlatabileceği bir dizi işlemden oluşur.Örneğin, ilk zamanlayıcı sorunuyla ilgili hak talebinde bulunabilir ve ardından başka biri için ilk zamanlayıcı sorunu oluşturabilir, geri bildirim sağlayıp çekme isteklerini inceleyerek başkalarına yardımcı olabilir.
• Yalnızca ilk kez oynayanlar veya yeni katkıda bulunanlar için özel olarak belirtilen sorunların listesi.
• Eski sorunların listesi: Uzun süredir üzerinde çalışılmayan ve dolayısıyla katkıda bulunanlar tarafından seçilebilen sorunların listesi.
• Katkıda Bulunanların listesi: Moja Global depolarına şimdiye kadar katkıda bulunanların listesi.
• Son Katkıda Bulunanlar: Moja Global depolarına en son katkıda bulunan katkıda bulunanların listesi.
• Sohbet forumlarına katılmak için kullanılabilecek bağlantılar: Kullanıcıların sorgularını çözüme kavuşturmak ve projelerle ilgili daha fazla tartışmaya açmak için Slack topluluğuna katılmak için kullanılabilecek bilgiler ve bağlantılar.