Bazel'in dokümanlarına katkıda bulunduğunuz için teşekkür ederiz. Topluluğumuz için daha iyi dokümanlar oluşturmaya yardımcı olmanın birkaç yolu vardır.
Belge türleri
Bu sitede birkaç tür içerik yer alıyor.
- Teknik yazarlar ve mühendisler tarafından yazılan açıklayıcı belgeler. Bu sitenin büyük bir bölümü, kavramsal ve görev tabanlı kılavuzları içeren açıklayıcı dokümanlardan oluşur.
- Kod yorumlarından oluşturulan belgeler olan referans belgeleri. Referans doküman sayfalarında doğrudan değişiklik yapamazsınız. Bunun yerine, kaynağı değiştirmeniz gerekir.
Belgeleme altyapısı
Bazel dokümanları Google'dan sunulur ve kaynak dosyalar Bazel'in GitHub deposunda yansıtılır. GitHub'daki kaynak dosyalarında değişiklik yapabilirsiniz. Onaylanırsa değişiklikleri birleştirebilirsiniz. Bu durumda, Bazel'in bakımını yapan bir kişi, güncellemelerinizi yayınlamak için web sitesi kaynağını günceller.
Küçük değişiklikler
Hataları veya yazım hatalarını düzeltme gibi küçük değişiklikleri birkaç şekilde yapabilirsiniz.
- Çekme isteği. GitHub'da web tabanlı düzenleyici ile veya bir dalda çekme isteği oluşturabilirsiniz.
- Hata. Ayrıntıları ve önerilen değişiklikleri içeren bir hata kaydı oluşturabilirsiniz. Bazel dokümanlarının sahipleri güncellemeyi yapar.
Büyük değişiklikler
Mevcut dokümanlarda önemli değişiklikler yapmak veya yeni dokümanlar önermek istiyorsanız çekme isteği oluşturabilir ya da Google Dokümanı ile başlayıp Bazel sahipleriyle iletişime geçerek ortak çalışma yapabilirsiniz.