DokümantasyonKATKIDA BULUN

KATKIDA BULUN

Kabul ettiğimiz yamalar. Reddettiğimiz yamalar.

Açık katkıda bulunma süreci — disiplin konusunda biraz fikir sahibi, kim olduğunuz konusunda asla.

01

Üzerinde çalışacak bir şey seç

Depo, ilk-temas sorunlarını şöyle etiketler: good-first-issue. Bakımcılar, kapsamın adil ve adımların açık olduğunu doğrulamak için bunları triyaj eder. Birini bitirirseniz, etiketli bırakın — bir sonraki kişiye yardım eder.

Daha büyük işler için önce bir tartışma açın. Şunu deriz: evet, hayır, ya da henüz değil, işte nedeni. Hayır demek, zamanınıza saygı duymanın bir parçasıdır.

02

Commit'lerinizi imzalayın

shell# in your local clone
git config user.signingkey YOUR_KEY_FINGERPRINT
git config commit.gpgsign true
git config tag.gpgsign true

GPG-imzalı commit'ler şart koşarız. Bu kapı bekçiliğiyle ilgili değil — projenin tedarik zincirini dürüst tutmakla ilgili. Henüz bir anahtarınız yoksa, depo wiki'si birini oluşturmanızda size yol gösterir.

Sign-off satırı
Her commit mesajı bir Developer Certificate of Origin sign-off ile bitmelidir (Signed-off-by: Name <email>). Bunu otomatik eklemek için şunu kullanın: git commit -s.
03

Geleneksel bir commit mesajı yaz

commit messagefeat(lsia): emit telemetry on safe-mode entry

Adds a single counter when the immune-system engine enters safe mode.
The counter is hashed-pattern only and respects the privacy gate.

Refs: #842
Signed-off-by: A. Researcher <a@example.org>

İlk satır için Conventional Commits spesifikasyonunu izleriz. Gövde nedenini açıklar. Altbilgi, sorunlara veya ilgili değişikliklere atıfta bulunur.

04

Çekme isteğini aç

Çekme istekleri üç otomatik kapıdan ve bir insan incelemesinden geçer:

  • Tekrarlanabilir-derleme kontrolü, yamanızın determinizmi bozmadığını doğrular.
  • Gizlilik kapısı, hiçbir ham veri yolunun eklenmediğini doğrular.
  • Birim ve entegrasyon test paketi geçmelidir.
  • Birleştirmeden önce iki gözden geçiren onaylar. Güvenlik açısından hassas alanlar bir güvenlik gözden geçireni gerektirir.
Gizlilik kapısı başarısız olursa
Durun. Diff'i dikkatlice yeniden okuyun — test, bir kod yolu ham tanımlayıcıları (IP, e-posta, IMEI, GPS) sızdırabildiğinde başarısız olur. Çözüm neredeyse hiçbir zaman testi devre dışı bırakmak değildir.
05

Takdir

Kabul edilen her katkı bir sonraki sürüm notlarında görünür — anonimlik istemediğiniz sürece kredilendirilerek. AUTHORS dosyası, bir değişikliği ilk birleştirdiğinizde otomatik olarak güncellenir.

Daha büyük işler için — büyük bir özellik, bir denetim, bir çeviri — değişiklik günlüğü girişi sizi isminizle anar. Anonim kredi özel değil, olağan bir taleptir.

06

Davranış kuralları

Contributor Covenant 2.1'i izleriz. Kişisel saldırılar, tehditler, doxxing ve taciz, şikayet zinciri gerektirmeyen anında-uzaklaştırma ihlalleridir. Tam metin, depodaki CODE_OF_CONDUCT.md dosyasındadır.