Taahhüt Mesajı Kılavuzu

Mesajları kaydet

Net kaydetme mesajları, çekme isteklerinin incelenmesini ve sürüm notlarının oluşturulmasını kolaylaştırır. Blockly projesi, bu konuda yardımcı olması için geleneksel kayıtlardan yararlanıyor.

Her kaydetme aşağıdaki biçimde olmalıdır:

<type>: <description>

[optional body]

[optional footer(s)]

Çekirdek Blockly deposunda, bunu uygulamaya yardımcı olacak bir kayıt linter'i olduğunu unutmayın. Pull isteğinizde birden fazla kaydetme varsa linter, başlığı kontrol eder. Tek bir kaydetme işlemi varsa bu taahhüt kontrol edilir. Hem bireysel taahhütlerinizin hem de çekme isteği başlığının bu kurallara uyması önerilir.

Tür

Tür boş olmamalı ve hepsi küçük harf olmalıdır. Kabul edilen türlerin listesi aşağıda verilmiştir.

ev işi
Bağımlılıkları yükseltme gibi rutin/otomatik görevleri tamamlayan kaydetme işlemleri için kullanılır.
deprecate
İşlevselliği kullanımdan kaldıran taahhütler için.
feat
Blockly'ye yeni işlev ekleyen kaydetme işlemleri için.
fix
Blockly'deki hataları/hataları düzelten kaydetme işlemleri içindir.
iptal etmek
Yeni bir sürümün yayınlanmasıyla ilgili kaydetme işlemleri için.

Zarar veren değişiklikler

Zarar veren değişiklikler yapan taahhütler, taahhüt türünden sonra ! eklemelidir. Çarpıcı değişiklikler, uygulamalarında Blockly'yi kullanan geliştiricileri bozarak ekstra işler yapmak zorunda kalmalarına neden olabilir.

Örneğin: fix!: return type of workspace.paste

Zarar veren değişiklikler yukarıdaki geçerli türlerden herhangi birine sahip olabilir.

Açıklama

Açıklama boş olmamalı ve 256 karakterden kısa olmalıdır.

Metin

Gövde kısmı isteğe bağlıdır. Sağlanmışsa bu ve açıklama arasında boş bir satır olmalıdır. Bu alan, en fazla 256 karakterden oluşan satırlara ayrılmalıdır.

Genellikle bu tür bilgileri, doğrudan taahhüte ek olarak/alınan talep açıklamanıza eklemenizin tavsiye edildiğine dikkat edin.

Altbilgi isteğe bağlıdır. Sağlanırsa gövde ile arasında boş bir satır olmalıdır. Bu alan, en fazla 256 karakterden oluşan satırlara ayrılmalıdır.

Geleneksel olmayan kaydetme işlemlerini düzeltme

Değişikliklerinizi yaparken geleneksel kaydetme kullanmadıysanız kaydetme işleminizin sayısına bağlı olarak mesajları düzeltmek için iki seçeneğiniz vardır:

  1. Pull isteğinizde birden fazla kaydetme varsa çekme isteği başlığını koşullara uyacak şekilde düzenleyin. Pull isteği birleştiğinde diğer kaydetmeleriniz, başlığın kaydetme mesajı haline gelmesi için diğer kaydetme işlemleriniz sıkıştırılır.

  2. Pull isteğinizde tek bir kayıt varsa kaydetme mesajınızı git commit --amend kullanarak değiştirin, ardından değişikliklerinizi Blockly'deki çatalınıza zorlayın. Bu işlem, bu şubeyle ilişkili tüm açık çekme isteklerini otomatik olarak günceller. git push --force origin my-branch.