CONTRIBUTING-TR.md

PassWall'e Katkı

PassWall'e yardım etmek mi istiyorsun? Mükemmel, aramıza hoşgeldin. Bu dokümanı projeye nasıl katkıda bulunabileceğini göstermek için hazırladık. Gelecek katkıların için şimdiden teşekkürler.

İletişim kanalları

• "Nasıl yapılır?" soruları için StackOverflow.
• Hata (Bug) bildirimi, özellik (feature) önerisi veya proje kaynak kodu için GitHub.
• Konu tartışmaları için Slack.
• E-posta ile iletişim için [email protected].

Katkıda bulunacak bir şeyi nasıl bulabilirim ?

1. Öncelikle katkıda bulunulacak her konunun bir issue'su olması gerektiğini unutmayın. Bunun için issue sayfasına bakabilirsiniz.

2. Issue sayfasında öncelikle help wanted issue'larına bakın.

3. Sonrasında koddaki // TODO: kısımlarını düzeltmeyi deneyebilirsiniz.

4. Eğer yeni bir özellik (feature) olarak iyi bir fikriniz varsa veya bir hata (bug) bulursanız bu konuda bir konu (issue) açmaktan çekinmeyin ve eğer konu üzerinde çalışmak istiyorsanız mutlaka belirtin.

Görevlendirmeler

Katkıda bulunucak bir şey bulduğunuzda;

1. Eğer henüz açılmamışsa onunla ilgili bir issue açın,

2. Bu issue için kimsenin görevlendirilmediğinden emin olun,

3. Issue üzerinde çalışmak istediğinizi açmış olduğunuz issue'nun sonunda belirtin.

Bu işlemler sonrasında ilgili issue için görevlendirilirsisniz (assign).

Commit'ler ve Pull Request'ler

Nitelikli pull request'ler - yamalar, iyileştirmeler, yeni özellikler - bizim için harika yardımlardır. Bu yamalar, iyileştirmeler, yeni özellikler için pull request'ler yapılırken konuya (issue) odaklanılmalı ve konu ile ilgilisi olmayan commit atmaktan kaçınılmalıdır.

Lütfen büyük kapsamlı ve ciddi pull request yapmadan önce bilgilendirme yapın (yeni özellikleri uygulama, kod düzenleme gibi). Aksi takdirde proje geliştiricilerinin değişiklik yapılmasını istemeyebileceği bir feature vb. üzerinde çalışmak için gereksiz zaman harcama riskiyle karşı karşıya kalabilirsiniz.

Branch adlandırma politikası

PassWall aşağıdaki branch adlandırma politikasını kullanır.

Instance	Branch	Description, Instructions, Notes
Stable	stable	Accepts merges from Working and Hotfixes
Working	master	Accepts merges from Features/Issues and Hotfixes
Features/Issues	topic-*	Always branch off HEAD of Working
Hotfix	hotfix-*	Always branch off Stable

Branch ve workflow hakkında daha fazla bilgi burada

Yeni Contributor'lar için

Eğer daha önce hiç pull request yapmadıysanız aramıza hoşgeldiniz 🎉 😄.

1. Projeyi öncelikle fork'layın yani kendi alanınıza alın. (Fork) ve remote'ları yapılandırın:

   # Repo forkunuzu geçerli dizin üzerine klonlayın
   git clone https://github.com/<your-username>/<repo-name>
   # Klonlanan dizine gidin
   cd <repo-name>
   # Orjinal repoyu "upstream" adlı bir remote called'a atayın
   git remote add upstream https://github.com/passwall/<repo-name>

2. Eğer daha önce fork yaptıysanız, upstream üzerinden en son değişiklikleri alın:

   git checkout master
   git pull upstream master

3. Feature, fix ve değişiklikleriniz için yeni bir branch oluşturun (ana projenin development branch'ı olan master dışında):

   git checkout -b <topic-branch-name>

4. Uygun olduğunda testleri güncellediğinizden veya yeni bir test eklediğinizden emin olun. Patch'ler ve feature'lar test olmadan kabul edilmeyecektir.

5. Eklediğiniz veya değişiklik yaptığınız düzenlemelerin belgelendirmesini README.md dosyası üzerinde yapmayı unutmayın.

6. Kendi oluşturduğunuz branch'ınız üzerinden fork'unuza push edin:

   git push origin <topic-branch-name>

7. Net, anlaşılır bir başlık ve açıklama ile pull request açın. Konu hakkında yardımcı döküman

Açık kaynak projeye nasıl katkıda bulunulabileceğini anlatan daha detaylı bir dokümana şuradan ulaşabilirsiniz.

Hata bildirimi (Bug report)

Bir hata bildirimi için issue açarken aşağıdaki beş soruya cevap verdiğinizden emin olun.

1. Kullanılan GO sürümü nedir?
2. Hangi işletim sistemi ve işlemci mimarisi kullanıyorsunuz?
3. Ne yaptın?
4. Ne görmeyi bekliyordun?
5. Onun yerine ne gördün?