Coding Starter Projects

Projects-Starter-Projects

Repositori dasar untuk berbagi proyek starter Anda dengan orang lain dan membantu mereka tumbuh juga!

Pertama, terima kasih telah meluangkan waktu untuk berkontribusi!

Semua jenis kontribusi didorong dan dihargai. Lihat Daftar Isi untuk berbagai cara untuk membantu dan detail tentang bagaimana proyek ini menanganinya. Pastikan untuk membaca bagian yang relevan sebelum memberikan kontribusi Anda. Ini akan membuatnya jauh lebih mudah bagi kita pemelihara dan memperlancar pengalaman untuk semua yang terlibat. Komunitas menantikan kontribusi Anda.

Dan jika Anda menyukai proyek ini, tetapi tidak punya waktu untuk berkontribusi, tidak apa -apa. Ada cara -cara mudah lainnya untuk mendukung proyek dan menunjukkan apresiasi Anda, yang juga akan sangat kami sukai:

• Membintangi proyek
• Tweet tentang itu
• Rujuk proyek ini di readme proyek Anda
• Sebutkan proyek di pertemuan lokal dan beri tahu teman/kolega Anda

Daftar isi

• Kode Etik
• Saya punya pertanyaan
• Saya ingin berkontribusi
• Melaporkan bug
• Menyarankan peningkatan

Kode Etik

Proyek ini dan semua orang yang berpartisipasi di dalamnya diatur oleh Kode Etik yang berkontribusi.MD. Dengan berpartisipasi, Anda diharapkan untuk menegakkan kode ini. Harap laporkan perilaku yang tidak dapat diterima ke <>.

Saya punya pertanyaan

Jika Anda ingin mengajukan pertanyaan, kami berasumsi bahwa Anda telah membaca dokumentasi yang tersedia.

Sebelum Anda mengajukan pertanyaan, yang terbaik adalah mencari masalah yang ada yang mungkin membantu Anda. Jika Anda telah menemukan masalah yang sesuai dan masih membutuhkan klarifikasi, Anda dapat menulis pertanyaan Anda dalam masalah ini. Juga disarankan untuk mencari jawaban di internet terlebih dahulu.

Jika Anda masih merasa perlu mengajukan pertanyaan dan membutuhkan klarifikasi, kami merekomendasikan yang berikut:

• Buka masalah.
• Berikan konteks sebanyak mungkin tentang apa yang Anda jalani.
• Memberikan versi proyek dan platform (NodeJs, NPM, dll), tergantung pada apa yang tampaknya relevan.

Kami kemudian akan mengurus masalah ini sesegera mungkin.

Saya ingin berkontribusi

Pemberitahuan Hukum

Saat berkontribusi pada proyek ini, Anda harus setuju bahwa Anda telah menulis 100% dari konten, bahwa Anda memiliki hak yang diperlukan untuk konten dan bahwa konten yang Anda kontribusikan dapat disediakan di bawah lisensi proyek.

Melaporkan bug

Sebelum mengirimkan laporan bug

Laporan bug yang baik seharusnya tidak membuat orang lain perlu mengejar Anda untuk informasi lebih lanjut. Karena itu, kami meminta Anda untuk menyelidiki dengan cermat, mengumpulkan informasi dan menjelaskan masalah secara rinci dalam laporan Anda. Harap selesaikan langkah -langkah berikut sebelumnya untuk membantu kami memperbaiki bug potensial secepat mungkin.

• Pastikan Anda menggunakan versi terbaru.
• Tentukan apakah bug Anda benar -benar bug dan bukan kesalahan di sisi Anda misalnya menggunakan komponen/versi lingkungan yang tidak kompatibel (pastikan Anda telah membaca dokumentasi. Jika Anda mencari dukungan, Anda mungkin ingin memeriksa bagian ini).
• Untuk melihat apakah pengguna lain telah mengalami (dan berpotensi sudah memecahkan) masalah yang sama dengan yang Anda miliki, periksa apakah belum ada laporan bug yang ada untuk bug atau kesalahan Anda di pelacak bug.
• Pastikan juga untuk mencari di internet (termasuk Stack Overflow) untuk melihat apakah pengguna di luar komunitas GitHub telah membahas masalah ini.
• Kumpulkan informasi tentang bug:
• Stack Trace (Traceback)
• OS, Platform dan Versi (Windows, Linux, MacOS, X86, ARM)
• Versi interpreter, kompiler, SDK, lingkungan runtime, manajer paket, tergantung pada apa yang tampaknya relevan.
• Mungkin masukan dan output Anda
• Bisakah Anda mereproduksi masalah dengan andal? Dan dapatkah Anda juga mereproduksinya dengan versi yang lebih lama?

Bagaimana cara mengirimkan laporan bug yang bagus?

Anda tidak boleh melaporkan masalah, kerentanan, atau bug yang terkait dengan keamanan termasuk informasi sensitif kepada pelacak masalah, atau di tempat lain di depan umum. Sebaliknya bug sensitif harus dikirim melalui email ke <>.

Kami menggunakan masalah GitHub untuk melacak bug dan kesalahan. Jika Anda mengalami masalah dengan proyek:

• Buka masalah. (Karena kami tidak dapat memastikan pada titik ini apakah itu bug atau tidak, kami meminta Anda untuk tidak membicarakan bug dan belum memberi label masalah.)
• Jelaskan perilaku yang Anda harapkan dan perilaku yang sebenarnya.
• Harap berikan konteks sebanyak mungkin dan jelaskan langkah -langkah reproduksi yang dapat diikuti orang lain untuk menciptakan kembali masalah ini sendiri. Ini biasanya termasuk kode Anda. Untuk laporan bug yang baik, Anda harus mengisolasi masalah dan membuat test case yang dikurangi.
• Berikan informasi yang Anda kumpulkan di bagian sebelumnya.

Setelah diajukan:

• Tim proyek akan memberi label masalah sesuai.
• Seorang anggota tim akan mencoba mereproduksi masalah dengan langkah -langkah yang Anda berikan. Jika tidak ada langkah reproduksi atau tidak ada cara yang jelas untuk mereproduksi masalah ini, tim akan meminta Anda untuk langkah-langkah itu dan menandai masalah tersebut sebagai needs-repro . Bug dengan tag needs-repro tidak akan ditangani sampai direproduksi.
• Jika tim dapat mereproduksi masalah ini, itu akan ditandai needs-fix , serta mungkin tag lain (seperti critical ), dan masalah ini akan diterapkan oleh seseorang.

Menyarankan peningkatan

Bagian ini memandu Anda melalui mengirimkan saran peningkatan untuk berkontribusi.md, termasuk fitur yang benar -benar baru dan peningkatan kecil untuk fungsionalitas yang ada . Mengikuti pedoman ini akan membantu pengelola dan masyarakat untuk memahami saran Anda dan menemukan saran terkait.

Sebelum mengirimkan peningkatan

• Pastikan Anda menggunakan versi terbaru.
• Baca dokumentasi dengan cermat dan cari tahu apakah fungsionalitas sudah dibahas, mungkin dengan konfigurasi individual.
• Lakukan pencarian untuk melihat apakah peningkatan telah disarankan. Jika sudah, tambahkan komentar ke masalah yang ada alih -alih membuka yang baru.
• Cari tahu apakah ide Anda sesuai dengan ruang lingkup dan tujuan proyek. Terserah Anda untuk membuat kasus yang kuat untuk meyakinkan pengembang proyek tentang manfaat fitur ini. Perlu diingat bahwa kami menginginkan fitur yang akan berguna bagi sebagian besar pengguna kami dan bukan hanya sebagian kecil. Jika Anda hanya menargetkan sebagian kecil pengguna, pertimbangkan untuk menulis perpustakaan add-on/plugin.

Bagaimana cara mengirimkan saran peningkatan yang baik?

Saran peningkatan dilacak sebagai masalah github.

• Gunakan judul yang jelas dan deskriptif untuk masalah ini untuk mengidentifikasi saran tersebut.
• Berikan deskripsi langkah demi langkah tentang peningkatan yang disarankan dalam sebanyak mungkin detail.
• Jelaskan perilaku saat ini dan jelaskan perilaku mana yang Anda harapkan untuk dilihat dan mengapa. Pada titik ini Anda juga dapat memberi tahu alternatif mana yang tidak cocok untuk Anda.
• Anda mungkin ingin memasukkan tangkapan layar dan gif animasi yang membantu Anda menunjukkan langkah -langkah atau menunjukkan bagian yang terkait dengan saran tersebut. Anda dapat menggunakan alat ini untuk merekam GIF pada macOS dan Windows, dan alat ini atau alat ini di Linux.
• Jelaskan mengapa peningkatan ini akan berguna bagi sebagian besar pengguna yang berkontribusi.md. Anda mungkin juga ingin menunjukkan proyek -proyek lain yang menyelesaikannya lebih baik dan yang dapat berfungsi sebagai inspirasi.