Peta dunia

 

EN

Dunia 12: Misi Kerjaya

Dokumentasi dan changelog

Anda akan belajar: cara beritahu pengguna apa yang berubah, dengan changelog.

Teks BM belum disemak oleh penutur asli.

Masalahnya

Aplikasi nota anda dapat kemas kini. Satu butang berpindah. Pengguna tanya: apa yang berubah? Log anda cuma tulis “wip” dan “stuff”.

Tengok

Tekan baris yang namakan versi ini dan tarikhnya.

0 daripada 1 dijumpai

changelog (log perubahan) (changelog): Senarai perubahan dalam setiap versi, ditulis untuk manusia. (senarai perubahan) ialah diari untuk pengguna. Setiap versi senaraikan apa yang ditambah, diubah atau dibaiki. Versi terbaru duduk di atas.

Cuba

Satu gaya yang popular, Keep a Changelog, kumpulkan entri bawah tajuk. Susun setiap entri.

Seret kad ke dalam kotak. Atau ketik kad, kemudian ketik kotak.

        Teka

        Anda baiki pepijat hari ini. Versi seterusnya keluar minggu depan. Di mana nota itu ditulis?

        Cuba

        CHANGELOG.md anda dah siap ditulis. Simpan dalam satu commit (titik simpan). Mulakan mesej dengan docs:.

        Folder kerja
        Kawasan staging
        • Kosong
        Repositori
        • 3 titik simpan
        • fix again
        • stuff
        • wip

        Semak

        Dokumentasi yang bagus membesar bersama kod. Nilai setiap tabiat.

        Leret ke kanan untuk bagus, ke kiri untuk perlu baiki. Atau guna butang.

        1 / 5

        Kemas kini README dalam PR yang sama dengan ciri baru

        Anda berjaya!

        Kini anda boleh jaga changelog yang pengguna faham.

        Nak tahu lebih (pilihan)

        Conventional Commits membantu di sini. Commit feat: selalunya jadi Added. Commit fix: jadi Fixed. World 6 terangkan gaya ini. Sesetengah alat buat draf changelog daripada commit anda. Manusia tetap perlu suntingnya. Keep a Changelog juga ada tajuk Deprecated, Removed dan Security.