Skip to content

Latest commit

 

History

History
180 lines (121 loc) · 15.9 KB

CONTRIBUTING.MD

File metadata and controls

180 lines (121 loc) · 15.9 KB

Pengantar

SELAMAT DATANG!

Pertama, terima kasih telah berkontribusi untuk Admin Aktif.

[sumber: [Admin Aktif] (https://github.com/activeadmin/activeadmin/blob/master/CONTRIBUTING.md)] ** Perlu lebih banyak inspirasi? ** [1] [Baca The Docs] (http: // read-the-docs.readthedocs.org/en/latest/contribute.html) [2] [Mustache.js] (https://github.com/janl/mustache.js/#contributing)

Beri tahu mereka mengapa mereka harus membaca panduan Anda.

Mengikuti panduan ini membantu untuk mengkomunikasikan bahwa Anda menghormati waktu para pengembang mengelola dan mengembangkan proyek sumber terbuka ini. Sebagai imbalannya, mereka harus membalas rasa hormat itu dalam mengatasi masalah Anda, menilai perubahan, dan membantu Anda menyelesaikan permintaan penarikan Anda.

[sumber: [Hoodie] (https://github.com/hoodiehq/hoodie/blob/master/CONTRIBUTING.md)]

Jelaskan jenis kontribusi apa yang Anda cari.

Tetap berpikiran terbuka! Memperbaiki dokumentasi, memilah bug, atau menulis tutorial adalah contoh dari kontribusi yang bermanfaat yang berarti lebih sedikit bekerja untuk Anda.

Elasticsearch adalah proyek sumber terbuka dan kami senang menerima kontribusi dari komunitas kami - Anda! Ada banyak cara untuk berkontribusi, dari menulis tutorial atau posting blog, meningkatkan dokumentasi, mengirimkan laporan bug dan permintaan fitur atau menulis kode yang dapat dimasukkan ke dalam Elasticsearch sendiri.

[sumber: [Elasticsearch] (https://github.com/elastic/elasticsearch/blob/master/CONTRIBUTING.md)] ** Perlu lebih banyak inspirasi? ** [1] [Rencanakan] (https://github.com / plataformatec / devise / wiki / Kontribusi) [2] [Geocoder] (https://github.com/alexreisner/geocoder#known-issue) ("masalah yang diketahui")

Jelaskan kontribusi yang TIDAK Anda cari (jika ada).

Sekali lagi, mendefinisikan ini di depan berarti lebih sedikit pekerjaan untuk Anda. Jika seseorang mengabaikan panduan Anda dan mengirimkan sesuatu yang tidak Anda inginkan, Anda dapat menutupnya dan menunjuk ke kebijakan Anda.

Tolong, jangan gunakan pelacak masalah untuk [pertanyaan dukungan]. Periksa apakah saluran IRC #pocoo di Freenode dapat membantu masalah Anda. Jika masalah Anda tidak sepenuhnya Werkzeug atau Flask spesifik, #python umumnya lebih aktif. Stack Overflow juga layak dipertimbangkan.

[sumber: [Flask] (https://github.com/pallets/flask/blob/master/CONTRIBUTING.rst)] ** Perlu lebih banyak inspirasi? ** [1] [timun-ruby] (https: // github .com / timun / ruby-ruby / blob / master / CONTRIBUTING.md # about-to-create-a-new-github-issue) [2] [Baca Docs] (http: // baca-the-docs. readthedocs.org/en/latest/open-source-philosophy.html#unsupported)

Aturan Dasar

Tetapkan harapan untuk perilaku (milik Anda, dan milik mereka).

Ini termasuk tidak hanya bagaimana berkomunikasi dengan orang lain (bersikap hormat, perhatian, dll) tetapi juga tanggung jawab teknis (pentingnya pengujian, ketergantungan proyek, dll). Sebutkan dan tautkan ke kode etik Anda, jika Anda memilikinya.

Tanggung jawab

  • Pastikan kompatibilitas lintas platform untuk setiap perubahan yang diterima. Windows, Mac, Debian & Ubuntu Linux.
  • Pastikan kode yang masuk ke inti memenuhi semua persyaratan dalam daftar periksa ini: https://gist.github.com/audreyr/4feef90445b9680475f2
  • Buat masalah untuk perubahan besar dan penyempurnaan apa pun yang ingin Anda buat. Diskusikan hal-hal secara transparan dan dapatkan umpan balik dari komunitas.
  • Jangan menambahkan kelas apa pun ke basis kode kecuali benar-benar diperlukan. Kesalahan di sisi penggunaan fungsi.
  • Simpan versi fitur sekecil mungkin, lebih disukai satu fitur baru per versi.
  • Sambutlah para pendatang baru dan dorong beragam kontributor baru dari semua latar belakang. Lihat [Kode Etik Komunitas Python] (https://www.python.org/psf/codeofconduct/).

[sumber: [cookiecutter] (https://github.com/audreyr/cookiecutter/blob/master/CONTRIBUTING.rst)] ** Perlu lebih banyak inspirasi? ** [1] [Seledri] (https://github.com /celery/celery/blob/master/CONTRIBUTING.rst#community-code-of-conduct) [2] [geocoder] (https://github.com/alexreisner/geocoder#contributing)

Kontribusi Pertama Anda

Bantu orang yang baru mengenal proyek Anda, pahami di mana mereka bisa sangat membantu. Ini juga saat yang tepat untuk memberi tahu orang jika Anda mengikuti konvensi label untuk menandai masalah pemula.

Tidak yakin dari mana harus mulai berkontribusi ke Atom? Anda dapat memulai dengan mencari tahu masalah-masalah pemula dan yang diinginkan oleh bantuan ini: Masalah Pemula - masalah yang seharusnya hanya membutuhkan beberapa baris kode, dan satu atau dua tes. Membantu masalah yang diinginkan - masalah yang seharusnya sedikit lebih terlibat daripada masalah pemula. Kedua daftar masalah diurutkan berdasarkan jumlah komentar total. Meskipun tidak sempurna, sejumlah komentar merupakan proxy yang masuk akal untuk memengaruhi perubahan yang diberikan.

[sumber: [Atom] (https://github.com/atom/atom/blob/master/CONTRIBUTING.md#your-first-code-contribution)] ** Perlu lebih banyak inspirasi? ** [1] [Baca Docs] (http://docs.readthedocs.org/en/latest/contribute.html#contributing-to-development) [2] [Django] (https://docs.djangoproject.com/en/dev/internals/ berkontribusi / kontributor baru / # langkah pertama) (gulir ke bawah ke "Panduan" juga)

Poin bonus: Tambahkan tautan ke sumber daya untuk orang-orang yang belum pernah berkontribusi untuk open source sebelumnya.

Siniadalah beberapa tutorial ramah yang dapat Anda sertakan: http://makeapullrequest.com/ dan http://www.firsttimersonly.com/

Mengerjakan Permintaan Tarik pertama Anda? Anda dapat mempelajari caranya dari seri * gratis * ini, [Cara Berkontribusi pada Proyek Sumber Terbuka di GitHub] (https://egghead.io/series/how-to-contribute-to-an-open-source-project- on-github).

[sumber: [Bereaksi] (https://github.com/facebook/react/blob/master/CONTRIBUTING.md#pull-requests)]

Sebagai catatan tambahan, ada baiknya menggunakan bahasa yang lebih ramah pengguna di seluruh dokumen Anda. Berikut adalah beberapa contoh dari [Admin Aktif] (https://github.com/activeadmin/activeadmin/blob/master/CONTRIBUTING.md):

Pada titik ini, Anda siap melakukan perubahan! Jangan ragu untuk meminta bantuan; semua orang adalah pemula pada awalnya: smile_cat:

Jika seorang pengelola meminta Anda untuk "me-rebase" PR Anda, mereka mengatakan bahwa banyak kode telah berubah, dan Anda perlu memperbarui cabang Anda agar lebih mudah untuk digabungkan.

Mulai

Beri mereka panduan singkat tentang cara mengirimkan sumbangan.

Bagaimana Anda menulis ini terserah Anda, tetapi beberapa hal yang mungkin ingin Anda sertakan:

  • Beri tahu mereka jika mereka perlu menandatangani CLA, menyetujui DCO, atau mengeluarkan barang hukum lainnya
  • Jika tes diperlukan untuk kontribusi, beri tahu mereka, dan jelaskan cara menjalankan pengujian
  • Jika Anda menggunakan hal lain selain GitHub untuk mengelola masalah (misalnya JIRA atau Trac), beri tahu mereka alat mana yang harus mereka sumbangkan

Untuk sesuatu yang lebih besar dari satu atau dua perbaikan baris:

  1. Buat fork Anda sendiri
  2. Lakukan perubahan dalam fork Anda
  3. Jika Anda suka perubahan dan berpikir proyek bisa menggunakannya: * Pastikan Anda telah mengikuti gaya kode untuk proyek tersebut. * Tandatangani Perjanjian Lisensi Kontributor, CLA, dengan Yayasan jQuery. * Perhatikan Kode Perilaku jQuery Foundation. * Kirim permintaan tarik yang menunjukkan bahwa Anda memiliki PKB dalam file.

[sumber: [Requirejs] (http://requirejs.org/docs/contributing.html)] ** Perlu lebih banyak inspirasi? ** [1] [Admin Aktif] (https://github.com/activeadmin/activeadmin/ blob / master / CONTRIBUTING.md # 1-where-do-i-go-from-here) [2] [Node.js] (https://github.com/nodejs/node/blob/master/CONTRIBUTING.md # code-contribution) [3] [Ember.js] (https://github.com/emberjs/ember.js/blob/master/CONTRIBUTING.md#pull-requests)

Jika Anda memiliki proses yang berbeda untuk perbaikan kecil atau "jelas", beri tahu mereka.

Kontribusi kecil seperti memperbaiki kesalahan ejaan, di mana konten cukup kecil untuk tidak dianggap sebagai kekayaan intelektual, dapat dikirimkan oleh kontributor sebagai tambalan, tanpa CLA.

Sebagai aturan praktis, perubahan adalah perbaikan yang jelas jika tidak memperkenalkan fungsi baru atau pemikiran kreatif. Selama perubahan tidak mempengaruhi fungsi, beberapa contoh yang mungkin termasuk yang berikut:

  • Perbaikan ejaan / tata bahasa
  • Koreksi tipo, spasi dan format putih berubah
  • Pembersihan komentar
  • Perbaikan bug yang mengubah nilai kembalian default atau kode kesalahan yang disimpan dalam konstanta
  • Menambahkan pesan logging atau output debug
  • Perubahan pada file ‘metadata’ seperti Gemfile, .gitignore, skrip, dll.
  • Memindahkan file sumber dari satu direktori atau paket ke yang lain

[sumber: [Chef] (https://github.com/chef/chef/blob/master/CONTRIBUTING.md#chef-obvious-fix-policy)] ** Perlu lebih banyak inspirasi? ** [1] [Wayang] (https://github.com/puppetlabs/puppet/blob/master/CONTRIBUTING.md#making-trivial-changes)

Cara melaporkan bug

Jelaskan pengungkapan keamanan pertama!

Minimal, termasuk kalimat ini:

Jika Anda menemukan kerentanan keamanan, jangan membuka masalah. Email XXXX sebagai gantinya.

Jika Anda tidak ingin menggunakan informasi kontak pribadi Anda, siapkan alamat email "keamanan @". Proyek yang lebih besar mungkin memiliki proses yang lebih formal untuk mengungkapkan keamanan, termasuk komunikasi terenkripsi. (Pengungkapan: Saya bukan ahli keamanan.)

Masalah keamanan apa pun harus diserahkan langsung ke [email protected] Untuk menentukan apakah Anda berurusan dengan masalah keamanan, tanyakan pada diri sendiri dua pertanyaan berikut:

  • Dapatkah saya mengakses sesuatu yang bukan milik saya, atau sesuatu yang seharusnya tidak saya akses?
  • Dapatkah saya menonaktifkan sesuatu untuk orang lain?

Jika jawaban untuk kedua pertanyaan itu adalah "ya", maka Anda mungkin berurusan dengan masalah keamanan. Perhatikan bahwa bahkan jika Anda menjawab "tidak" untuk kedua pertanyaan, Anda mungkin masih berurusan dengan masalah keamanan, jadi jika Anda tidak yakin, cukup kirim email kepada kami di [email protected].

[sumber: [Travis CI] (https://github.com/travis-ci/travis-ci/blob/master/CONTRIBUTING.md)] ** Perlu lebih banyak inspirasi? ** [1] [Seledri] (https: //github.com/celery/celery/blob/master/CONTRIBUTING.rst#security) [2] [Express.js] (https://github.com/expressjs/express/blob/master/Security.md)

Beri tahu kontributor Anda cara mengajukan laporan bug.

Anda bahkan dapat menyertakan template sehingga orang hanya dapat menyalin-tempel (lagi, lebih sedikit bekerja untuk Anda).

Saat mengajukan masalah, pastikan untuk menjawab lima pertanyaan ini:

  1. Versi Go apa yang Anda gunakan (versi go)?
  2. Sistem operasi dan arsitektur prosesor apa yang kamu menggunakan?
  3. Apa yang Anda lakukan?
  4. Apa yang Anda harapkan untuk dilihat?
  5. Apa yang Anda lihat? Pertanyaan umum harus masuk ke milis golang-alih alih-alih pelacak masalah. Akan menghubungkan di sana akan menjawab atau meminta Anda untuk mengajukan masalah jika Anda tersandung bug.

[sumber: [Pergi] (https://github.com/golang/go/blob/master/CONTRIBUTING.md#filing-issues)] ** Perlu lebih banyak inspirasi? ** [1] [Seledri] (https: / /github.com/celery/celery/blob/master/CONTRIBUTING.rst#other-bugs) [2] [Atom] (https://github.com/atom/atom/blob/master/CONTRIBUTING.md#reporting- bugs) (termasuk template)

Bagaimana cara menyarankan fitur atau peningkatan

Jika Anda memiliki peta jalan, tujuan, atau filosofi khusus untuk pengembangan, bagikan di sini.

Informasi ini akan memberikan konteks kontributor sebelum mereka membuat saran yang mungkin tidak selaras dengan kebutuhan proyek.

Filosofi Express adalah untuk menyediakan perkakas yang kecil dan kuat untuk server HTTP, menjadikannya solusi hebat untuk aplikasi halaman tunggal, situs web, hibrida, atau API HTTP publik.

Express tidak memaksa Anda untuk menggunakan mesin ORM atau template tertentu. Dengan dukungan untuk lebih dari 14 mesin template melalui Consolidate.js, Anda dapat dengan cepat membuat kerangka kerja yang sempurna.

[sumber: [Express] (https://github.com/expressjs/express#philosophy)] ** Perlu lebih banyak inspirasi? ** [Admin Aktif] (https://github.com/activeadmin/activeadmin#goals)

Jelaskan proses yang Anda inginkan untuk menyarankan suatu fitur.

Jika ada bolak-balik atau signoff diperlukan, katakan demikian. Minta mereka untuk memperluas fitur, memikirkan mengapa itu diperlukan dan bagaimana cara kerjanya.

Jika Anda menemukan diri Anda berharap untuk fitur yang tidak ada di Elasticsearch, Anda mungkin tidak sendirian. Pasti ada orang lain di luar sana dengan kebutuhan yang sama. Banyak fitur yang Elasticsearch miliki saat ini telah ditambahkan karena pengguna kami melihat kebutuhan tersebut. Buka masalah pada daftar masalah kami di GitHub yang menggambarkan fitur yang ingin Anda lihat, mengapa Anda membutuhkannya, dan bagaimana cara kerjanya.

[sumber: [Elasticsearch] (https://github.com/elastic/elasticsearch/blob/master/CONTRIBUTING.md#feature-requests)] ** Perlu lebih banyak inspirasi? ** [1] [Hoodie] (https: / /github.com/hoodiehq/hoodie/blob/master/CONTRIBUTING.md#feature-requests) [2] [Ember.js] (https://github.com/emberjs/ember.js/blob/master/CONTRIBUTING. md # requesting-a-feature)

Proses peninjauan kode

Jelaskan bagaimana kontribusi diterima setelah diajukan.

Siapa yang mengulasnya? Siapa yang perlu menandatangani sebelum diterima? Kapan seorang kontributor mengharapkan untuk mendengar dari Anda? Bagaimana bisa kontributor mendapatkan akses komit, jika sama sekali?

Tim inti melihat Permintaan Tarik secara rutin dalam pertemuan triase mingguan yang kami pegang di Google Hangout publik. Hangout diumumkan dalam pembaruan status mingguan yang dikirim ke daftar boneka-dev. Catatan diposting ke repo komunitas-triase Komunitas Boneka dan sertakan tautan ke rekaman YouTube dari hangout tersebut. Setelah umpan balik diberikan, kami mengharapkan tanggapan dalam dua minggu. Setelah dua minggu, kami dapat menutup permintaan tarik jika tidak menunjukkan aktivitas apa pun.

[sumber: [Wayang] (https://github.com/puppetlabs/puppet/blob/master/CONTRIBUTING.md#submitting-changes)] ** Perlu lebih banyak inspirasi? ** [1] [Meteor] (https: / /meteor.hackpad.com/Responding-to-GitHub-Issues-SKE2u3tkSiH) [2] [Express.js] (https://github.com/expressjs/express/blob/master/Contributing.md#becoming-a- committer)

Masyarakat

Jika ada saluran lain yang Anda gunakan selain GitHub untuk mendiskusikan kontribusi, sebutkan di sini. Anda juga dapat membuat daftar penulis, pengelola, dan / atau kontributor di sini, atau menetapkan harapan untuk waktu tanggapan.

Anda dapat mengobrol dengan tim inti di https://gitter.im/cucumber/cucumber. Kami mencoba untuk memiliki jam kantor pada hari Jumat.

[sumber: [timun-ruby] (https://github.com/cucumber/cucumber-ruby/blob/master/CONTRIBUTING.md#talking-with-other-devs)] ** Perlu lebih banyak inspirasi? ** [1] [Chef] (https://github.com/chef/chef/blob/master/CONTRIBUTING.md#-developer-office-hours) [2] [Cookiecutter] (https://github.com/audreyr / komunitas cookiecutter #)

BONUS: Kode, komit pesan dan konvensi pelabelan

Bagian-bagian ini tidak diperlukan, tetapi dapat membantu menyederhanakan kontribusi yang Anda terima.

Jelaskan gaya yang Anda sukai untuk kode, jika Anda memilikinya.

** Perlu inspirasi? ** [1] [Requirejs] (http://requirejs.org/docs/contributing.html#codestyle) [2] [Elasticsearch] (https://github.com/elastic/elasticsearch/blob /master/CONTRIBUTING.md#contributing-to-the-elasticsearch-codebase)

Jelaskan jika Anda menggunakan konvensi pesan komitmen apa pun.

** Perlu inspirasi? ** [1] [Sudular] (https://github.com/angular/material/blob/master/.github/CONTRIBUTING.md#submit) [2] [Node.js] (https: //github.com/nodejs/node/blob/master/CONTRIBUTING.md#step-3-commit)

Jelaskan jika Anda menggunakan konvensi label apa pun untuk masalah.

** Perlu inspirasi? ** [1] [StandardIssueLabels] (https://github.com/wagenet/StandardIssueLabels#standardissuelabels) [2] [Atom] (https://github.com/atom/atom/blob/master /CONTRIBUTING.md#issue-and-pull-request-labels)