From 29904840b21e0eeaccce864704f6c7d5966c20d1 Mon Sep 17 00:00:00 2001 From: Orcun Serce Date: Thu, 4 Mar 2021 11:43:32 +0000 Subject: [PATCH] CONTRIBUTING.md: dizin yapisi ve baglanti yapisi eklendi --- CONTRIBUTING.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 862111f..d673ce9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -72,6 +72,30 @@ Anlamlı bir mesaj yazdıktan sonra, değişiklik isteğinizi açın. Eğer bir Değişiklik isteğiniz depo bekçileri tarafından incelenerek kısa bir sürede karara bağlanacaktır. +## Depo düzeni + +* `guvenlik/` :deponun kök dizini; +Lisans, katkı gönergeleri, depo hakkında genel bilgi vb dosyaları ve guvenlik rehberinin kaynak dizini __src__'yi içerir. + +* `guvenlik/src` Güvenlik Rehberi'nin kök dizini; + - __theme/__ css, ikonlar vb. tema dosyalarını içerir. + - __credits.md__: katkıda bulunanlar + - __README.md__: giriş sayfası + - __SUMMARY.md__: içindekiler, sayfa solundaki indeks + - __kullanilmayan/__: hazırlanıp kullanılmamış veya sayfalardan çıkarılmış, kullanılabilecek görseller + - ve ana başlıkları içerir. + +* Ana başlıklar ve alt başlıkların düzeni + - Her bir başlık __`.md`__ ve gerekli ise __`/`__ adlarında bir dosya ve bir dizinden oluşur. + - __`.md`__: markdown sintaksıyla yazılmış sayfa içeriğidir. + - __`/`__ dizini içinde __`.md`__ sayfasında kullanılan görseller, alt başlıklar, kod parçaları gibi ayrı dosyalar olarak bulunan içeriği barındırır. Alt başlıklar aynı yapıya sahiplerdir: `.md`, `/` + +* Sayfalarda kullanılan bağlantılar: `[Bağlantı adı](baglantiAdresi)`; + - İç bağlantılar için __``__ içinde geçtiği dosya konumuna bağıl olarak kullanılır: + - `[Bağlantı adı](../../anaBaslik/altBaslik/altAltBaslik/altAltBaslik.md)` + - `![Görsel tanımı](baslik/gorsel.png)` + - Dış bağlantılar protokol ile başlayacak şekilde tam olarak kullanılmalı ve sadece güvenli bağlantı `[...](https:/...)` kullanılamıyorsa `[...](http://...)` kullanılmalıdır. + ## Önemli uyarılar 1. **YERELDE TEST ETMEDİĞİNİZ HİÇBİR ŞEYİ DEĞİŞİKLİK İSTEĞİ OLARAK AÇMAYIN.**