Xokul, Nokul projesinin bir parçasıdır ve aynı kural ve ilkelere sahiptir. Lütfen öncelikle Nokul'un katkı verme dokümanlarını okuyun.
Xokul'a katkı vermek istiyor ancak projede yeniyseniz, başlangıçta izlemeniz gereken adımlar aşağıda belirtilmiştir.
- Projeyi kendi GitHub hesabınıza fork edin.
- Fork edilen projeyi lokal geliştirme ortamınıza klonlayın.
- Lokal geliştirme dizinine geçin.
- Projeyi lokalde çalıştırmak için gerekli adımlar burada belirtilmiştir. Bu adımları takip edin.
Xokul'a iş kaydı açarak katkı vermek istiyorsanız, izlemeniz gereken adımlar aşağıda belirtilmiştir.
-
Öncelikle projenin son sürümü üzerinde çalıştığınızdan emin olun.
-
İş kaydı açmadan önce, kapatılmış veya açık olan iş kayıtlarını kontrol edin. Benzer iş kaydı daha önce açılmış ve
- Kapatılmış ise tekrar açın.
- Halâ açık ise "thumbs up" kullanarak reaksiyon gösterin.
-
İş kaydı başlığında tanımlayıcı etiketler kullanmayın (örn. bug, feature). Kod sahipleri tarafından ilgili etiket atanacaktır.
-
Açtığınız iş kaydına proje sahiplerinin yoğunluğuna göre hemen cevap verilemeyebilir. Bu tip durumlarda, yeniden iş kaydı açmak yerine zaten açık olan iş kaydı altında reaksiyon gösterin.
-
Sizden iş kaydı içeriğine göre detaylı bilgiler istenebilir. Belirli bir süre içerisinde dönüş yapmazsanız iş kaydı kapatılacaktır.
-
İş kaydı şablonundaki kurallara mutlaka uyun.
Bir "pull request", öncelikle şunlara ihtiyaç duyar (bunların bir kısmı şablonda belirtilmiştir):
- Dokümantasyon
- İyi yazılmış komit mesajları
- Testler
"Pull request" açmadan önce geliştirme ortamı adımını okuyun. Eğer bu adımı geçtiyseniz şu kılavuza uygun şekilde "pull request" açabilirsiniz.
Katkı verdiyseniz teşekkürler!
Şüpheli güvenlik açıklarını lütfen [email protected] adresine bildirin. Lütfen önemli güvenlik açıkları için herkese açık iş kayıtları oluşturmayın.