Bekerjasama untuk Slack sebagai Pembangun Sumber Terbuka

pengenalan

Adakah anda pembangun pemula yang ingin mendapatkan lebih banyak pengalaman dan tertanya-tanya dari mana untuk bermula? Catatan blog ini adalah untuk anda!

Salah satu cara terbaik untuk membina kemahiran anda ialah dengan menyumbang kepada projek sumber terbuka. Baru-baru ini, saya menangani isu dalam Repo GitHub SlackAPI. Pada masa penulisan, permintaan tarik (PR) saya telah diterima oleh salah seorang penyelenggara, ia telah melepasi semua binaan CI dan baru digabungkan!?

Dalam siaran ini, saya akan berkongsi perjalanan saya untuk menyelesaikan isu ini, cabaran yang saya hadapi dan pengajaran yang saya pelajari sepanjang perjalanan.

Isu

Isu yang saya usahakan ialah mengenai pengendalian URL dalam Slack API. Khususnya, kod itu tidak menambahkan garis miring (/) pada base_url jika ia tiada, yang boleh membawa kepada panggilan API yang tidak konsisten atau gagal.

Contohnya:

• Tanpa garis miring mengekor: https://slack.com/api
• Dengan garis miring mengekor: https://slack.com/api/

Tiada garis miring yang hilang menyebabkan isu halus yang perlu ditangani untuk memastikan kebolehpercayaan. Matlamat saya adalah untuk mengubah suai kod untuk menambahkan garis miring secara automatik jika ia tidak diberikan.

Anda boleh menemui isu asal di sini: #1541.

Cabaran

Mencari Fail yang Betul untuk Diedit

Sebagai seorang pemula yang menangani pangkalan kod yang besar, cabaran pertama saya ialah mencari tempat untuk membuat perubahan. Menavigasi melalui direktori yang tidak dikenali dan memahami struktur projek mengambil masa. Membaca dokumentasi dan melangkah melalui kod membantu saya mencari fail yang berkaitan.

Menulis Pembaikan

Setelah saya mengenal pasti fail (base_client.py), saya merangka penyelesaian untuk memastikan base_url berakhir dengan /. Namun, sebelum melaksanakannya, saya telah menghubungi pihak penyelenggara untuk mendapatkan bimbingan. Mereka menegaskan bahawa logik yang serupa juga harus digunakan pada dua fail lain: async_base_client.py dan legacy_base_client.py. Ini merupakan peringatan yang baik tentang kepentingan komunikasi yang jelas dan pra-perbincangan dalam projek kerjasama.

Berikut ialah coretan kod yang dikemas kini untuk menambahkan garis miring di belakang:

if not base_url.endswith("/"):
    base_url += "/"

Perubahan mudah ini memastikan semua panggilan API akan menggunakan URL asas yang konsisten. Saya juga mereplikasi logik ini dalam dua fail lain, mengekalkan konsistensi merentas pelanggan yang berbeza.

Menambah Ujian

Pengujian merupakan bahagian penting dalam pembetulan ini. Saya menambah ujian baharu dalam fail test_web_client.py untuk mengesahkan bahawa base_url telah diperbetulkan jika ia tiada garis miring di belakang. Contohnya:

• Input: http://localhost:8888
• Output yang dijangkakan: http://localhost:8888/

Berikut ialah versi ringkas salah satu ujian yang saya tambahkan:

if not base_url.endswith("/"):
    base_url += "/"

Bawa pulang

Kepentingan Pengujian

Sebelum menyerahkan PR anda, uji perubahan anda dengan teliti. Menulis ujian unit, menjalankan ujian sedia ada dan menggunakan alat penyahpepijatan adalah langkah penting untuk memastikan kod anda berfungsi seperti yang diharapkan. Dengan mengautomasikan ujian untuk kes tepi, anda boleh menangkap kemungkinan ralat lebih awal dan meningkatkan keyakinan terhadap penyelesaian anda.

Ikuti Garis Panduan Sumbangan

Setiap projek sumber terbuka mempunyai garis panduan sumbangannya sendiri. Pastikan anda membaca dan mengikutinya dengan teliti, kerana mereka menggariskan piawaian pengekodan, keperluan ujian dan proses penyerahan PR. Contohnya, SlackAPI memberikan arahan yang jelas tentang menyediakan persekitaran pembangunan dan menjalankan ujian.

Komunikasi Adalah Kunci

Pra-membincangkan perubahan anda dengan penyelenggara boleh menjimatkan masa dan mengelakkan berulang-alik yang tidak perlu. Dalam kes saya, ia memastikan saya menggunakan pembetulan pada semua fail yang berkaitan, menjadikan penyelesaian lebih komprehensif.
Jangan Takut Meminta Bantuan

Jika anda buntu, jangan teragak-agak untuk bertanya soalan. Penyelenggara dan penyumbang sumber terbuka selalunya menyokong dan bersedia membantu pendatang baharu.

Fikiran Akhir

Menyumbang kepada sumber terbuka boleh berasa menakutkan pada mulanya, tetapi ini adalah salah satu cara terbaik untuk berkembang sebagai pembangun. Anda akan belajar bekerja dalam satu pasukan, menavigasi pangkalan kod yang besar dan menulis kod sedia pengeluaran. Selain itu, berasa menakjubkan melihat karya anda digunakan oleh orang lain!

Jika anda seorang pembangun pemula, saya menggalakkan anda untuk meneroka projek sumber terbuka, mencari isu yang menarik minat anda dan mengambil risiko. Repo GitHub SlackAPI ialah tempat yang bagus untuk bermula!

Adakah anda telah menyumbang kepada projek sumber terbuka? Kongsi pengalaman anda dalam komen di bawah! ?

Atas ialah kandungan terperinci Bekerjasama untuk Slack sebagai Pembangun Sumber Terbuka. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!