Kaydetme mesajı rehberi

Kaydetme mesajları

Net commit mesajları, çekme isteklerinin incelenmesini ve sürüm notlarının oluşturulmasını kolaylaştırır. Blockly projesi, bu konuda yardımcı olmak için geleneksel commit'leri kullanır.

Her commit şu biçimde olmalıdır:

<type>: <description>

[optional body]

[optional footer(s)]

Temel Blockly deposunda bunu zorunlu kılmaya yardımcı olan bir commit linter'ı olduğunu unutmayın. Çekme isteğinizde birden fazla commit varsa linter başlığı kontrol eder. Tek bir commit varsa bu commit'i kontrol eder. Hem bireysel işlemelerinizin hem de çekme isteği başlığınızın bu yönergelere uyması en iyisidir.

Tür

Tür boş olmamalı ve tamamen küçük harflerden oluşmalıdır. Kabul edilen türlerin listesini aşağıda bulabilirsiniz.

  • chore: Bağımlılıkları yükseltme gibi rutin/otomatik görevleri tamamlayan commit'ler için.

  • deprecate: İşlevlerin desteğini sonlandıran commit'ler için.

  • feat: Blockly'ye yeni işlevler ekleyen commit'ler için.

  • fix: Blockly'deki hataları/hataları düzelten commit'ler için.

  • release: Yeni bir sürümün yayınlanmasıyla ilgili commit'ler için.

Zarar veren değişiklikler

Kırıcı değişiklikler yapan commit'ler, commit türünden sonra ! eklemelidir. Kırıcı değişiklikler, uygulamalarında Blockly kullanan geliştiricilerin uygulamalarını bozabilecek ve ek iş yapmalarına neden olabilecek değişikliklerdir.

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

Önemli 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 isteğe bağlıdır. Sağlanıyorsa başlık ile açıklama arasında boş bir satır olmalıdır. 256 karakterden uzun olmayan satırlara bölünmelidir.

Genellikle bu tür bilgileri doğrudan commit'e eklemek yerine çekme isteği açıklamanıza eklemenin daha iyi olacağını unutmayın.

Altbilgi isteğe bağlıdır. Sağlanması durumunda, bu satır ile gövde arasında boş bir satır olmalıdır. 256 karakterden uzun olmayan satırlara bölünmelidir.

Geleneksel olmayan commit'leri düzeltme

Değişikliklerinizi yaparken geleneksel commit'leri kullanmadıysanız kaç commit'iniz olduğuna bağlı olarak iletileri düzeltmek için iki seçeneğiniz vardır:

  1. Çekme isteğinizde birden fazla commit varsa çekme isteği başlığını şartlara uygun şekilde düzenleyin. Çekme isteği birleştirildiğinde diğer işlemeleriniz birleştirilerek başlık, işleme mesajı haline gelir.

  2. Çekme isteğinizde tek bir commit varsa git commit --amend kullanarak commit mesajınızı değiştirin, ardından değişikliklerinizi Blockly'nin çatallanmış sürümüne zorla gönderin. Bu işlem, bu dal ile ilişkili açık çekme isteklerini otomatik olarak günceller. git push --force origin my-branch.