Halaman ini diterjemahkan oleh Cloud Translation API.

project global moja

Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.

Ringkasan proyek

Organisasi open source:: moja global
Penulis teknis:: Tlazypanda
Nama proyek:: Dokumentasi Panduan Orientasi Teknis untuk FLINT
Durasi proyek:: Durasi standar (3 bulan)

Project description

Dokumentasi Panduan Orientasi Teknis untuk FLINT guna memandu kontributor baru melalui orientasi teknis sehingga kontributor baru dapat dengan mudah memulai dengan dukungan minimum dari pengelola.

Masalah Project

Berikut adalah daftar masalah paling penting terkait dokumentasi saat ini: - Petunjuk panduan penyiapan lokal yang tidak teratur sehingga menyulitkan kontributor baru untuk memulai. - Banyak repositori FLINT tidak memiliki dokumentasi tujuan dan tidak ditautkan satu sama lain sehingga sulit bagi pengguna baru untuk mengidentifikasi repositori mana yang akan diinstal. - Penginstalan Windows didokumentasikan dengan baik, tetapi dokumentasi penginstalan berbasis Linux masih memerlukan perbaikan. - Alur kerja Git saat ini bukan bagian dari dokumentasi

Solusi yang Diusulkan

Proposal ini menyajikan solusi untuk membimbing kontributor baru melalui orientasi teknis sehingga kontributor baru dapat dengan mudah memulai dengan dukungan minimum dari pengelola. Hal ini dapat dilakukan dengan memfaktorkan ulang dokumentasi saat ini agar mudah digunakan oleh pengguna pemula dan juga memelihara repositori mandiri terpusat untuk semua dokumentasi yang tersedia. Project ini dibagi menjadi tiga fase:- - Meninjau dokumentasi dan pemfaktoran ulang yang ada: Tujuan dari fase ini adalah meninjau panduan saat ini dan memfaktorkannya ulang sedemikian rupa sehingga membuatnya ringkas dan mudah dipahami oleh kontributor baru. Dokumentasi juga perlu dimodifikasi agar lebih cocok untuk pemula dengan menambahkan badge, emoji, dan informasi tentang masalah yang diberi label dengan tag masalah pertama khusus timer pertama atau tag masalah pertama yang baik. - Membuat repositori dokumentasi mandiri yang terpusat: Tujuan dari fase ini adalah untuk menautkan semua dokumentasi yang tersedia dalam urutan logis yang berurutan pada repositori mandiri. Hal ini melibatkan pengurutan panduan kontribusi, petunjuk penyiapan proyek, dan panduan langkah demi langkah. - Tambahkan alur kerja Pengembang dan situs web komunitas untuk pengembang baru: Tujuan dari fase ini adalah menambahkan alur kerja Pengembang yang berisi panduan kontribusi git dan arsitektur teknologi proyek bersama dengan pengujian dan pedoman UM (Uji Mutu). Situs komunitas yang diusulkan akan berupa aplikasi web satu halaman yang menampilkan alur kerja, masalah pertama kali yang dapat diklaim oleh kontributor baru, dan daftar semua kontributor. Tahap 1: Tinjau dokumentasi dan pemfaktoran ulang yang ada:

Ubah dokumentasi terbaru dari repositori berikut: - FLINT: Dokumentasi saat ini tidak terlalu mendetail dan tidak memberikan urutan library prasyarat yang berurutan. Panduan petunjuk langkah demi langkah dibagi menjadi beberapa file pdf yang berbeda, tetapi dapat disatukan di satu tempat dengan cara yang lebih ringkas. Selain itu, panduan penginstalan disesuaikan untuk jendela, namun untuk penginstalan Linux, pengalihan ke repositori FLINT.docker dapat bermanfaat. - FLINT.docker: Dokumentasi saat ini tidak memberikan tujuan di balik setelan repositori ini, yaitu untuk menyediakan penginstalan FLINT di Linux melalui docker. Dukungan melalui Docker hanya terbatas pada Ubuntu 18.04 (Bionic Beaver), tetapi dapat diperluas ke distribusi berbasis Linux lainnya. Dokumentasi saat ini juga perlu menekankan pada cara berurutan menyiapkan dockerfile dan juga informasi yang cukup tentang cara membangun dari makefile. - FLINT.example: Dokumentasi saat ini tidak memberikan tujuan di balik setelan repositori ini, yaitu memberikan contoh cara menggunakan FLINT. Berbagai sampel berjalan dapat dipisahkan dengan lebih baik dengan instruksi spesifik agar dapat dijalankan. Kita juga perlu menautkan repositori ini ke repositori FLINT utama yang memberi pengguna cara untuk menavigasi ke sini untuk melihat contoh yang diterapkan.

Informasi berikut perlu ditambahkan ke dokumentasi terbaru: - Penggunaan Git dan GitHub: Hal ini akan mencakup petunjuk langkah demi langkah tentang cara melakukan fork, clone, dan menyetel upstream jarak jauh untuk repositori. Bagian ini juga akan memberikan informasi tentang cara melakukan rebase terhadap master terbaru dan menangani konflik penggabungan. - Lencana & Emoji: Dokumentasi saat ini tidak memiliki Lencana dan Emoji, sehingga dapat membantu kontributor baru merasa disambut dan menganggap masalah ini tidak terlalu sulit. - Informasi tentang masalah untuk Pemula/Pemula: Hal ini akan membantu mengarahkan kontributor baru pada masalah yang mudah dipahami bagi pemula dan situs komunitas. - Informasi tentang repositori Import-me: Repositori Import-me bertindak sebagai template dasar pengukuran untuk memulai repositori Moja Global apa pun. Dokumentasi saat ini gagal menyebutkan pentingnya hal yang sama. Perlu diupdate untuk menyebutkan repositori Import-me dan langkah untuk memilihnya sebagai template saat membuat repositori baru juga perlu ditambahkan. Seharusnya juga ada proses yang mapan bagi coder untuk menyarankan fitur tambahan untuk repositori Import-me.

Tahap 2: Membuat repositori dokumentasi mandiri terpusat :

Alat yang akan digunakan untuk platform hosting:

Alat yang diusulkan untuk platform hosting ini adalah Read The Docs karena alasan berikut:- - Memiliki peringkat tinggi di antara berbagai platform hosting. - Pembaruan otomatis saat mendorong commit - Dukungan yang mudah disiapkan dan pemecahan masalah tersedia dengan mudah karena digunakan oleh komunitas besar - Dokumentasi diformat menggunakan reStructuredText dan hasilnya dikompilasi oleh Sphinx.

Mengatur semua konten secara logis dan berurutan:

Urutan konten yang diusulkan adalah sebagai berikut:- - Pengantar dokumentasi developer: Bagian ini akan membahas pengantar Moja Global dan FLINT. - Berkontribusi: Bagian ini akan terdiri dari subbagian “Cara Berkontribusi” (dalam hal kode/pelaporan bug/terjemahan/dokumentasi/pengorganisasian acara, dll.) dan “Kode Etik”. - Penyiapan Pengembangan: Bagian ini akan terdiri dari subbagian “Alur Kerja Git & GitHub”, “Penginstalan Windows”, “Penginstalan Linux”. - Alur Kerja Developer: Bagian ini akan terdiri dari diskusi tentang alat yang terintegrasi secara manual untuk pengujian dan cara melakukan permintaan selanjutnya. - Bergabunglah dengan kami: Bagian ini akan menyediakan berbagai forum sosial seperti saluran Slack untuk terhubung dan bekerja sama dengan Moja Global.

Tahap 3: Tambahkan alur kerja developer dan situs komunitas untuk kontributor baru:

Dokumentasi Alur Kerja Developer:

Dokumentasi alur kerja developer akan terdiri dari subbagian berikut:

Tech Stack/Arsitektur yang digunakan dan berbagai modul dalam kode: Dokumentasi untuk membiasakan diri kontributor baru dengan Tech stack yang diimplementasikan, berbagai library dan modul codebase.
Alat pengujian dan cakupan terintegrasi: Memperkenalkan kontributor baru pada alat pipeline CI/CD yang digunakan untuk pengujian, bot Cakupan dan Pemeriksaan Kualitas Otomatis dijalankan berdasarkan kode mereka. Selain itu, dengan memberikan panduan tentang pendekatan yang harus dilakukan, jika pengujian gagal.
Bot yang digunakan untuk memudahkan alur kerja, misalnya Zulipbot: Mendesain template konten agar bot dapat ditampilkan dan menyediakan Dokumentasi agar pengguna dapat memahami bot dan bahkan meningkatkan konfigurasi bot dengan berkontribusi.
Menguji dan mengirimkan permintaan pull secara manual: Dokumentasi yang akan diberikan tentang cara menguji permintaan Pull secara manual terhadap standar tertentu dan mengupload hasilnya dalam hal screenshot/gif saat mengirimkan Permintaan Pull.
Panduan meminta peninjauan permintaan pull yang harus diikuti oleh kontributor: Pedoman tentang pemberian tag kepada tim tertentu untuk ditinjau dan menambahkan label seperti "perlu ditinjau" ke permintaan pull untuk memungkinkan pengelola merespons kembali.

Situs Komunitas:

Situs komunitas akan memiliki fitur berikut:-

Informasi tentang Alur Kerja kami: Alur kerja akan terdiri dari serangkaian tindakan yang dapat dimulai oleh kontributor baru, yaitu mengklaim masalah timer pertama, diikuti dengan membuat masalah timer pertama untuk orang lain dan membantu orang lain dengan memberikan masukan dan meninjau permintaan pull mereka.
Daftar masalah Khusus timer pertama: Daftar masalah yang secara khusus ditujukan untuk pemula atau kontributor baru.
Daftar masalah yang Tidak berlaku: Daftar masalah yang belum ditangani dalam jangka waktu lama, sehingga dapat dipilih oleh kontributor.
Daftar Kontributor: Daftar kontributor yang sejauh ini telah berkontribusi pada repositori Moja Global.
Kontributor Terbaru: Daftar kontributor yang baru-baru ini berkontribusi pada repositori Moja Global.
Link untuk bergabung ke forum chat: Informasi dan link untuk bergabung dengan komunitas Slack guna menyelesaikan pertanyaan mereka dan melakukan diskusi lebih lanjut tentang project.