Dokumentasi pengembang telah pindah! Lihat https://www.popclip.app/dev/ untuk dokumen terbaru.
Ekstensi Popclip
Repositori ini berisi file sumber untuk banyak ekstensi yang diterbitkan di direktori ekstensi popclip resmi.
Tata letak repositori
Folder utama:
-
source - Sumber untuk ekstensi yang diterbitkan (dipelihara dan didukung oleh saya) -
contrib - Folder untuk ekstensi yang tidak dipublikasikan / dikontribusikan / eksperimental / niche / arsip (tidak dikelola atau didukung)
Berkontribusi
Perbaikan dan peningkatan ekstensi yang ada dipersilakan melalui permintaan pull.
Untuk menyumbangkan ekstensi baru ke direktori, cara yang disukai adalah untuk mengirimkannya langsung ke server direktori dari repo Anda sendiri. Halaman direktori ekstensi akan ditautkan ke repo Anda dan Anda akan mempertahankan dan memperbarui ekstensi sendiri. Hubungi saya di Mailto: [email protected] untuk instruksi pengiriman.
Atau, ekstensi baru dapat diserahkan dengan permintaan tarik di folder contrib repo ini. (Jika saya menerbitkannya, saya akan memindahkannya ke folder source sendiri.)
Pedoman Kualitas
Harap dicatat saya tidak akan mempublikasikan semua pengiriman. Ekstensi yang akan diterbitkan harus berkualitas tinggi dan memenuhi kriteria berikut:
- Ekstensi memiliki tujuan tunggal yang jelas dan berguna bagi audiens umum.
- Ekstensi "Just Works", dengan hanya konfigurasi minimal oleh pengguna.
- Nama yang dipilih dengan baik, sesuai dengan gaya penamaan ekstensi lainnya. Nama biasanya satu atau dua kata; Misalnya ✅ "Instapaper", bukan "Kirim ke Instapaper"; ✅ "huruf besar" tidak "dikonversi menjadi huruf besar".
- Ikon yang bagus, jelas mewakili tindakan. (Gunakan simbol Iconify atau SF jika Anda bukan seorang desainer.)
- Di konfigurasi,
description yang jelas, ringkas, dan satu kalimat tentang apa yang dilakukan ekstensi. Inilah yang muncul di situs web di sebelah nama ekstensi. - Terlepas dari ekstensi paling sederhana, sertakan file
readme.md yang menjelaskan secara singkat cara menggunakan ekstensi, terutama menyebutkan fitur khusus dan opsi konfigurasi. Tambahkan changelog di bagian bawah readme. - Di mana kunci API diperlukan, ini harus didokumentasikan dengan jelas dalam readme dengan instruksi dan tautan untuk mendapatkan kunci.
- Tidak ada skrip yang tidak ada gunanya. Misalnya, jangan gunakan skrip bash untuk membuka URL ketika Anda bisa menggunakan tindakan
url . - Mendukung tindakan JavaScript daripada skrip shell atau tindakan apel kecuali tindakan tertentu benar -benar perlu menjadi skrip shell atau apel.
- Ekstensi skrip shell harus bekerja di luar kotak pada instalasi default macOS terbaru. Saya tidak akan mempublikasikan ekstensi yang mengharuskan pengguna untuk menginstal bahasa atau perpustakaan skrip tambahan.
- Gunakan readme untuk memberikan kredit kepada diri sendiri sebagai penulis dan mengakui kontributor lain, perpustakaan open source, atau pencipta ikon.
- Tidak ada biner yang dikompilasi. Semua pengiriman harus hanya kode sumber.
- Ekstensi yang berinteraksi dengan situs web atau aplikasi harus memiliki kamus
app di konfigurasi, mendefinisikan name dan bidang link . Nama akan secara otomatis ditautkan dalam deskripsi ekstensi. - Untuk ekstensi yang berfungsi dengan aplikasi MacOS pihak ke -3, kunci
bundleIdentifiers dengan checkInstalled: true juga harus digunakan juga. - Tidak ada ekstensi yang bertujuan menghindari hak cipta, mengalahkan paywalls dll.
- Tidak ada tautan ke situs torrent / filesharing yang sebagian besar mengindeks konten yang dilindungi hak cipta.
- Tidak ada "telepon rumah", mengumpulkan data pengguna, atau memodifikasi sistem pengguna dengan cara apa pun.
- Tidak ada yang ilegal atau berbahaya atau Anda tidak akan menunjukkan kepada nenek Anda.
- Daftar di atas tidak lengkap dan saya berhak untuk menolak pengiriman karena alasan lain.
Dengan semua yang dikatakan ... tolong kirimkan ekstensi Anda! Saya tidak sabar untuk melihat apa yang Anda hasilkan.
Kredit
Kredit termasuk dalam file readME ekstensi individu.
Lisensi
Semua kode sumber diterbitkan di bawah lisensi MIT (lisensi.txt) kecuali dinyatakan sebaliknya dalam file extension readme.
Changelog
Perubahan individu termasuk dalam file extension readme.