Bu sayfa, Google Dokümanlar Sezonu için kabul edilen bir teknik yazı projesinin ayrıntılarını içerir.
Proje özeti
- Açık kaynak kuruluşu:
- AboutCode
- Teknik yazar:
- ayansinha
- Projenin adı:
- Tarama kodu araç setindeki Komut Satırı Seçenekleri için referans ve aboutcode.readthedocs.io adresindeki AboutCode dokümanlarının yapısını yeniden organize etme referansı
- Proje süresi:
- Standart uzunluk (3 ay)
Proje açıklaması
[ 1. Scancode-Toolkit Komut Satırı Seçenekleri ]
Scancode-Toolkit'te tarama işleminin nasıl yapıldığını, çıkış biçimini ve tarama sonrası eklentiler gibi diğer seçenekleri özelleştirmek için kullanabileceğiniz çok sayıda Komut Satırı seçeneği bulunur. Bu seçenekler şu anda bunları açıklayan uygun dokümanlara sahip değildir ve yalnızca "--help" veya "-h" işaretleriyle kullanılabilir. Bu proje, aşağıdakileri açıklayan eksiksiz belgeler hazırlamayı amaçlamaktadır:
[ 1. Komut Satırı üzerinden kullanılabilen Tüm Seçenekler ]
- Hedef: Komut satırı üzerinden kullanılabilecek tüm olası seçeneklerin kapsamlı bir listesi.
- Temel Genel Bakış: İlk olarak, çıktının bir örneğiyle varsayılan tarama seçenekleri tartışılır. Taramanın nasıl yapıldığını gösteren kısa bir grafik/açıklama.
Bundan sonra bu varsayılan davranış, diğer seçeneklerin taramayı ve sonucu nasıl değiştirdiğine dair bir referans işlevi görür.
Bunlar ayrıntılı olarak ele alınacaktır ve sonraki bölümlerde bahsedileceği üzere aşağıdaki bilgileri içerecektir.
[ 2. Sürüm Oluşturma Yapısını Başlatın ]
- Hedef: Sürümler arası seçenekleri/API'leri ve belge değişikliklerini düzgün bir şekilde sürdürmek için bir sürüm oluşturma sistemini başlatmak.
- Sorun: Şu anda wiki ve ReadTheDokümanlar sayfalarındaki belgeler eski sürümlere yöneliktir ve kapsamlı bir yeniden yapılandırma gerektirir.
- Temel Genel Bakış: Tarama kodu araç setinin, sürümde güncellenen/güncellenebilecek bölümleri
- Komut Satırı Seçenekleri
- API'ler
- Belgeler (Başlatılacak) Sürüm ve sürümlerde komut satırı seçenekleri ve API'ler değiştirilmiştir. Belgelerin de buna uyması gerekir, aksi takdirde kullanıcılar için büyük bir kafa karışıklığı meydana gelir. Komut satırı yardımcı programı [ --help ], seçeneklerdeki değişiklikler için zaten güncellenmiştir ve dokümanlardaki sürüm oluşturmayı çoğaltmak için kullanılabilir.
[ 3. Bu Seçenekler farklı durumlarda nasıl kullanılabilir? ]
- Hedef: Bu bölümde, tarama kodu araç setinin tarama sonuçlarının farklı amaçlar için nasıl kullanılabileceği ve bu işlevi sağlayan Scancode-Toolkit seçenekleri hakkında temel bir özet sunulmaktadır.
- Temel Genel Bakış: Bu bölümde, farklı kullanım alanı senaryoları örnekleri ve bu senaryolarda önerilen seçenekler verilmektedir.
- Not: Bu kısım, Scancode-Toolkit'in çeşitli kullanım örnekleri hakkında bilgiler ve bu örneklere yönlendiren bilgiler açısından mentorun önemli yardımını gerektirir.
[ 4. Tarama ve Çıkış'ta bu Seçenekler neleri değiştirir? ]
- Hedef: Bu bölümde, tarama kodu araç setinin tarama sonuçlarının farklı amaçlar için nasıl kullanılabileceği ve bu işlevleri sağlayan Aboutcode araçları hakkında temel bir özet sunulmaktadır.
- Temel Genel Bakış: Seçenekler, tarama işleminin davranışını değiştirir. İlk bölümde [ 1. Komut Satırı ] aracılığıyla kullanılabilen tüm Seçenekler. Bu bölümde, tüm seçeneklerin bu varsayılan senaryoya getirdiği değişiklikler karşılaştırılır.
[ 5. Çıktı Biçimleri ve örnekleri ]
- Hedef: Bu bölümde, tarama kodu araç setinin tarama sonuçlarının farklı amaçlar için nasıl kullanılabileceği ve bu işlevleri sağlayan Aboutcode araçları hakkında temel bir özet sunulmaktadır.
- Temel Genel Bakış: Scancode-Tool'da, tarama sonuçlarının oluşturulacağı farklı çıkış biçimlerini belirten işaretler bulunur. Bunlar,
Bu bölümde - ve çıkış formatlarını ayrıntılarıyla
- çıkış biçimleriyle ilgili örnekler verin
- çıkış biçimine ve kullanımına karşılık gelen diğer bağlantıları verin.
- ve tarama sonuçlarının çıkış dosyalarında nasıl depolandığını Bu, [ 2. Kod Tarama ile ilgili tartışmalar ].
[ 6. Scancode Çıktı Biçimlerinin Ticari Kullanımı ]
- Hedefler: Scancode Çıktısı biçimlerinin Ticari Kullanım alanlarını açıklama GSoD fikirler listesinde Scancode Çıktı Biçimleri, referans olarak bahsedilmiştir. Bu bölümde de aynı durum uygulanır.
- Not: Bu kısım, Scancode-Toolkit'in işle ilgili çeşitli kullanım alanları hakkında girişler ve bunlara ilişkin işaretçiler açısından mentorun önemli ölçüde yardımını gerektirir.
[ 7. Bu çıkışlar, daha fazla analiz için diğer AboutCode projeleri tarafından nasıl kullanılıyor? ]
- Hedef: Bu bölümde, tarama kodu araç setinin tarama sonuçlarının farklı amaçlar için nasıl kullanılabileceği ve bu işlevleri sağlayan Aboutcode araçları hakkında temel bir özet sunulmaktadır.
- Temel Genel Bakış:
- Scancode-Workbench Bu bölümde, sonuçları masaüstü uygulamasıyla görselleştirme ve aynı konuda daha fazla destek almak için kod çalışma alanı dokümanlarına yönlendiren işaretçiler açıklanmaktadır. Gerekirse kodu taramak için gereken belgeleri ekler.
- Deltacode İki kod tabanı arasındaki dosya düzeyi farklarını belirlemek için Deltacode tarafından tarama kodu sonuçları nasıl alınır?
[ 2. AboutCode Belgelerinin yapısını yeniden düzenleyin ]
Bu bölümde, Hakkında Kodu Dokümanlarında yapılan birçok değişiklik yer alır.
[ 1. Sürüm oluşturma sistemi ]
[ 1. Scancode-Toolkit Komut Satırı Seçenekleri -> 2. Sürüm Oluşturma Yapısını Başlatın] Komut Satırı seçenekleri için sürüm oluşturma sorunundan bahsedilmiştir. Aynı durum, belgenin normalde karışıklığa yol açabilecek sürüme özel komutlar/bilgiler içeren diğer bölümleri için de gereklidir.
[ 2. Dokümantasyon Standartlarını ve Testlerini Ayarlama ]
Dokümanlarda zaten Spinx-build (tüm sayfaları oluşturur ve Sfenks söz dizimi hatalarının olup olmadığını kontrol eder) ve Travis-CI aracılığıyla Sürekli Entegrasyon ile bağlantı kontrolü (dokümanlardaki diğer web sayfalarının tüm bağlantılarını kontrol eder) için testler vardır. (17 numaralı çekme isteğine benim tarafımdan eklendi) Şimdi, yeniden Yapılandırılmış Metin ve diğer standartlarda belirli hata analizi için daha fazla kontrole ihtiyacı var. Bu, yeniden yapılandırılmıştext-lint ile gerçekleştirilebilir. Ancak daha fazla araştırma yapılması gerekiyor ve bu proje, GSoD projem kapsamında gerçekleştirilecek.
[ 3. "Başlarken" bölümü ekleme ]
Bu, yeni başlayanlar için bir başlangıç bölümü görevi görür ve Aboutcode Projeleri’ni kullanmaya başlamak için gereken en temel ve en önemli belgelerin derlenmesini içerir. Scancode-Toolkit, Scancode-Workbench, Deltacode vb. dahil olmak üzere her Aboutcode projesinde bu bölüm bulunur.
[ 4. 4 Belge İşlevine Göre Yeniden Yapılandırma ]
Eğiticiler, Nasıl Yapılır?, Referans ve Açıklamalar adlı 4 doküman işlevinde mevcut belgeler açık bir şekilde yapılandırılmamıştır. Gerekirse daha fazla bilgi/açıklama/işaretçi ekleyerek bunları uygun şekilde yapılandırmayı öneriyorum. Bu, tüm AboutCode projeleri ve ilgili dokümanları için geçerlidir. Aşağıda, önerdiğim ve bu projeye devam etmek istediğim Scancode-Toolkit belgelerinin yeniden yapılandırılmasına ilişkin iki örnek verilmiştir. Dokümanların geri kalanında da benzer değişiklikler yapılacaktır.
[ 5. Geliştirme Sayfasını Yeniden Yapılandırma (Scancode-Toolkit) ]
Geliştiricilere daha uygun olması için Kod/API'ler hakkında daha fazla bilgi eklenebilir. İlgili bağlantılar için [ 2. Yukarıdaki Kod Tarama ] bölümünü açıklayan tartışmalar. Bu bağlantı, taramanın nasıl çalıştığına ilişkin açıklamayı taramayı gerçekleştirmek için kullandığı kodla ilişkilendirir. Bu klasörler tarama kodu araç setinin farklı parçalarını içerdiğinden, tarama kodunun nasıl çalıştığıyla ilgili Tartışma bölümü ile birlikte bu klasörler API'lerle ayrıntılı şekilde açıklanabilir.
- [ cluecode : Lisansları, telif haklarını, url'leri, e-postaları taramak için kullanılan eklentiler ]
- [commoncode : yardımcı sınıflar ve işlevler]
- [ayıklama kodu : farklı arşiv biçimlerini çıkarır ]
- [ biçimlendirilmiş kod : farklı çıkış dosyası biçimleri için çıkış biçimlendirme ]
- [ lisanslı kodu : lisans algılama kodu ]
- [ paketli kod : çeşitli paket biçimlerini ayrıştırma ]
- [ eklenti kodu : eklenti mimarisi sınıfları ]
- [ summarycode : algılanan lisanslarla ilgili taramayı özetler ]
- [ metin kodu : metin ayrıştırmayı işler ]
- [ typecode : dosya türü belirlemelerini işler ]
- [ tarama kodu : Kodu taramak için KSA ve API, temel bölüm ]
Bu alt bölümde, tarama kodu araç setinin bu bölümleriyle ilgili ayrıntılı bilgileri/API'leri ilgili alt bölümlerde bulabilirsiniz. Geliştirme yönergeleri, daha küçük alt bölümleri olan başka bir sayfada veya başka bir bölümde yer alır.
[ 6. SSS sayfasını yeniden yapılandırma (Scancode-Toolkit) ]
Şu anda SSS sayfasında daha iyi cevaplanabilecek sorular bulunmaktadır ve bu sorular için ayrı "Nasıl Yapılır?", Eğitim ve Referans belgeleri olarak yapılandırılması gerekir.
- ScanCode nasıl çalışır? Bu soruna [ 2. (Kod Taraması ] konusunu açıklayan ve çok daha fazla ayrıntıyla tamamen ayrı bir bölüm olarak ele alınacaktır.
- Gelişmiş Algılama için Yeni Lisans Kuralları Nasıl Eklenir? Bu sorun daha önce Mevcut "Nasıl Yapılır?" kılavuzlarını iyileştirme bölümünde ele alınmıştı, dokümanlar buraya taşınacaktır.
- Yeni lisans algılama kuralı nasıl eklenir? Bu, ayrı bir "Nasıl Yapılır?" gönderisinde oluşturulabilir ve ayrıntılı bir şekilde ele alınabilir.
- Geliştirme sürecine nasıl başlanır? Zaten ayrı bir geliştirme sayfası vardır ve bilgiler epey örtüşüyor. Geliştirme sayfasının yeniden yapılandırılması, daha önce yukarıda ele alınmıştır.
- Yeni bir sürümü kesme adımları Bu adımlar, ayrı bir "Yeni sürümü kesme" bölümüne dönüştürülebilir.
- Proje hakkında genel soruları yanıtlayan ve "Nasıl Yapılır?"/"Eğitim" kategorilerine girmeyen daha fazla SSS sorusu bulun.