moja global projesi

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:

moja global

Teknik yazar:

Tlazypanda

Proje adı:

FLINT için Teknik İlk Katılım Kılavuzu Belgeleri

Proje süresi:

Standart uzunluk (3 ay)

Proje açıklaması

Yeni katkıda bulunanlara teknik ilk katılım sürecinde rehberlik etmek amacıyla FLINT için Teknik İlk Katılım Kılavuzu belgeleri.

Proje Sorunları

Mevcut belgelerle ilgili en önemli sorunların listesi aşağıda verilmiştir: - Yerel kurulum kılavuzu talimatlarının dağınık ve bu nedenle, katkıda bulunan yeni bir kullanıcının çalışmaya başlamasını zorlaştıran düzensiz parçalar. - Birden fazla FLINT deposunda amaca yönelik belgeler bulunmuyor ve birbirlerine bağlı değiller. Bu da yeni katılımcıların, hangi kod deposunun yükleneceğini belirlemesini zorlaştırıyor. - Windows kurulumu iyi bir şekilde belgelenmiştir, ancak Linux tabanlı yükleme dokümanlarında iyileştirme yapılabilir. - Git iş akışı şu anda ilgili dokümanlar arasında yer almıyor

Önerilen Çözüm

Bu teklif yeni katkıda bulunanlara teknik ilk katılım sürecinde rehberlik edebilecek bir çözüm sunar. Böylece yeni katkıda bulunanların başlangıç için minimum destekten yararlanmasını kolayca sağlayabiliriz. Bunun için mevcut belgeler yeniden düzenleyerek yeni başlayanlara uygun hale getirilebilir ve mevcut tüm belgeler için merkezi ve bağımsız bir veri havuzu oluşturulabilir. 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 şekilde yeniden düzenlemektir. Ayrıca, dokümanların yeni başlayanlar için daha uygun olacak şekilde değiştirilmesi gerekir. Bunun için rozetler, emojiler ve yalnızca ilk kez kullananlar ya da ilk sayı etiketleri ile etiketlenmiş sorunlarla ilgili bilgiler eklenebilir. - Merkezi ve bağımsız bir belge deposu oluşturma: Bu aşamanın amacı, mevcut tüm belgeleri mantıksal ve sıralı bir şekilde tek bir depoda birbirine bağlamaktır. Bu, 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 git katkı yönergelerini ve projenin teknoloji mimarisini 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 hata 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 gözden geçirme ve yeniden düzenleme:

Aşağıdaki kod depolarını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 ayrılmıştır, ancak daha kısa ve öz bir şekilde tek bir yerde birleştirilebilirler. Ayrıca, yükleme kılavuzları pencerelere göre hazırlanmıştır. Ancak Linux yüklemelerinde FLINT.docker deposuna yönlendirme yapmak faydalı olabilir. - FLINT.docker: Mevcut dokümanlar, bu depoyu ayarlama amacını açıklamıyor. Bu depo, FLINT'in Docker üzerinden Linux kurulumunun sağlanmasını amaçlıyor. 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ı olarak kurulmasına vurgu yapılması ve ayrıca, makefile dosyasından nasıl oluşturulacağına ilişkin yeterli bilgi yer almalıdır. - FLINT.örnek: Mevcut belgelerde bu deponun ayarlanmasındaki amaç belirtilmiyor. FLINT'in nasıl kullanılacağına dair bir örnek sunmak. Farklı örnek çalıştırmalar, çalışacakları belirli talimatlarla daha iyi ayrılabilir. Ayrıca, bu kod deposunu ana FLINT depomuza bağlamamız gerekiyor. Böylece, kullanıcılara buradaki örneği uygulamalı olarak görebilmeleri için bir yöntem sunulmalıdır.

Mevcut dokümanlara aşağıdaki bilgilerin eklenmesi gerekiyor: - Git ve GitHub kullanımı: Bu bilgiler arasında çatallama, klonlama ve depo için uzak yukarı akışın ayarlanmasıyla ilgili adım adım talimatlar yer alır. Ayrıca, en son ana steye göre yeniden baz alma ve birleştirme çakışmalarını ele alma hakkında bilgi de sağlar. - Rozetler ve Emojiler: Mevcut dokümanlarda, yeni katkıda bulunanların hoş karşılandığını hissetmelerini ve sorunların daha az göz korkutucu olduğunu bilmelerini sağlayabilecek Rozetler ve Emoji'ler bulunmuyor. - İlk Kronometreler/Yeni Başlayanlara Uygun sorunlar hakkında bilgi: Bu bilgiler, yeni katkıda bulunanları yeni başlayanlara uygun sorunlara ve topluluğun web sitesine yönlendirmeye yardımcı olur. - Import-me deposu hakkında bilgi: Import-me deposu herhangi bir Moja Global veri havuzunu başlatmak için temel şablon işlevi görür. Mevcut dokümanlarda bunun öneminden bahsedilmiyor. Import-me deposundan bahsedilecek şekilde güncellenmesi gerekir. Ayrıca, yeni kod deposu oluştururken bu depoyu şablon olarak seçme adımları da eklenmelidir. Ayrıca, kod yazarlarının Import-me deposu için ek özellikler önermeleri için yerleşik bir süreç de bulunmalıdır.

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

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 yer alır. - Taahhüt aktarımında otomatik güncelleme - Çok sayıda kullanıcı tarafından kullanıldığı için kurulumu kolay ve sorun giderme desteği - Belgeler reStructuredText kullanılarak biçimlendirilmiş ve çıktı Sphinx tarafından derlenmektedir.

Tüm içeriği mantıksal bir şekilde sıralı hale getirin:

Önerilen içerik sırası aşağıdaki gibidir:- - Geliştirici belgelerine giriş: Bu bölümde Moja Global ve FLINT tanıtılacaktır. - Katkıda bulunma: Bu bölüm, “Katkıda Bulunma Yöntemleri” (kod/raporlama hataları/çeviri/dokümanlar/düzenleme etkinlikleri vb. açısından) ve “Davranış Kuralları” alt bölümlerinden oluşur. - Geliştirme Kurulumu: Bu bölüm "Git ve GitHub İş Akışı", "Windows Kurulumu", "Linux Yüklemesi", "Linux Kurulumu"nun alt bölümlerinden oluşur. Çekme-- Geliştirici İş Akışı bu bölümde, belgenin bir sonraki test aşamasında nasıl entegre edileceği ve manuel olarak nasıl test edileceği, bu bölümde açıklanmıştır. - Bize katılın: Bu bölümde Moja Global ile bağlantı kurmak ve çalışmak için Slack kanalları gibi çeşitli sosyal forumlar sunulmaktadır.

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ığı, çeşitli kitaplıkların ve kod tabanının modülleriyle yeni katkıda bulunanları tanımaya yönelik belgeler.
• Entegre test ve kapsam araçları: Test için kullanılan CI/CD ardışık düzen araçlarına katkıda bulunan yeni kullanıcılar, Kapsam botları ve otomatik kalite kontrolleri kodlarına karşı çalışır. Ayrıca testlerin başarısız olması durumunda kiminle iletişime geçilmesi gerektiği konusunda yönergeler sağlanır.
• İş akışını kolaylaştırmak için kullanılan botlar, ör.Zulipbot: Bot'ların gösterileceği içerik şablonları tasarlama ve kullanıcıların botları anlamasını, hatta katkıda bulunarak bot yapılandırmasını geliştirmesini sağlamak için Dokümanlar'ı kullanma.
• Pull isteğinin manuel olarak test edilmesi ve gönderilmesi: Pull isteklerinin belirli standartlara göre manuel olarak test edilmesi ve Çekme İsteklerinin gönderilmesi sırasında ekran görüntüsü/gif bakımından sonuçların yüklenmesiyle ilgili belgeler sağlanacaktır.
• Katkıda bulunanların takip edeceği pull isteği inceleme kuralları: Belirli ekipleri inceleme için etiketleme ve bakım yapanların yanıt vermesine olanak tanımak için pull 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ız hakkında bilgi: İş akışı, yeni bir katkıda bulunan kullanıcının başlatabileceği bir dizi işlemden oluşur.Örneğin, ilk zamanlayıcılarla ilgili bir sorun bildirecek, ardından başka biri için bir ilk zamanlayıcı sorunu oluşturacaksınız ve geri bildirim sağlayıp çekme isteklerini gözden geçirerek başkalarına yardımcı olacaksınız.
• Yalnızca ilk kez kullananlarla ilgili sorunların listesi: Özellikle ilk kez kullananlar veya yeni katkıda bulunanlar için amaçlanan sorunların listesi.
• Eski sorunların listesi: Uzun süredir üzerinde çalışılmayan ve bu nedenle katkıda bulunanlar tarafından seçilebilecek sorunların listesi.
• Katkıda Bulunan Listesi: Moja Global veri havuzlarına şimdiye kadar katkıda bulunanların listesi.
• Son Katkıda Bulunanlar: Moja Global veri havuzlarına son zamanlarda katkıda bulunan katkıda bulunanların listesi.
• Sohbet forumlarına katılma bağlantıları: Kullanıcıların sorgularını çözüme kavuşturmak ve projelerle ilgili daha fazla tartışma sağlamak için Slack topluluğuna katılım bağlantıları ve bilgiler.