Kod Kalitesi

Mon, 01 Jan 0001 00:00:00 +0000

Kod Kalitesi

Denomas'ta kod kalitesi, geliştirme sürecinin ayrılmaz bir parçasıdır. Her commit, pre-commit hook'larından geçer; her MR, Otomatik Kalite Kapısından geçmek zorundadır. Bu kapı, bilinen güvenlik açıklarının (SQL injection, XSS vb.) koda girmesini en başından engeller.

Temel Kural

Her commit pre-commit hook'larından geçmelidir. İstisnasız.

Pre-commit Hooks

Tüm projelerde aşağıdaki pre-commit hook'ları aktiftir:

# .pre-commit-config.yaml
repos:
 # Genel dosya kontrolleri
 - repo: https://github.com/pre-commit/pre-commit-hooks
 rev: v4.6.0
 hooks:
 - id: trailing-whitespace
 - id: end-of-file-fixer
 - id: check-yaml
 args: ['--allow-multiple-documents']
 - id: check-json
 - id: check-merge-conflict
 - id: detect-private-key
 - id: check-added-large-files
 args: ['--maxkb=1024']
 - id: no-commit-to-branch
 args: ['--branch', 'main', '--branch', 'master']

 # Python: Ruff (flake8 + isort + pyupgrade birleşimi)
 - repo: https://github.com/astral-sh/ruff-pre-commit
 rev: v0.4.0
 hooks:
 - id: ruff
 args: ['--fix']
 - id: ruff-format

 # Python: Black (formatter)
 - repo: https://github.com/psf/black
 rev: 24.4.0
 hooks:
 - id: black
 args: ['--line-length=120']

 # Python: MyPy (tip kontrolü)
 - repo: https://github.com/pre-commit/mirrors-mypy
 rev: v1.10.0
 hooks:
 - id: mypy
 additional_dependencies: ['types-requests', 'types-redis']
 args: ['--ignore-missing-imports']

 # Python: Bandit (güvenlik taraması)
 - repo: https://github.com/PyCQA/bandit
 rev: 1.7.8
 hooks:
 - id: bandit
 args: ['-c', 'pyproject.toml', '-r']
 additional_dependencies: ['bandit[toml]']

 # Ansible
 - repo: https://github.com/ansible/ansible-lint
 rev: v24.2.0
 hooks:
 - id: ansible-lint

 # Docker
 - repo: https://github.com/hadolint/hadolint
 rev: v2.12.0
 hooks:
 - id: hadolint

 # Shell
 - repo: https://github.com/shellcheck-py/shellcheck-py
 rev: v0.10.0
 hooks:
 - id: shellcheck

 # Commit message format (Conventional Commits)
 - repo: https://github.com/compilerla/conventional-pre-commit
 rev: v3.2.0
 hooks:
 - id: conventional-pre-commit
 stages: [commit-msg]
 args: ['feat', 'fix', 'docs', 'style', 'refactor', 'test', 'chore', 'ci']

Doğrudan Ana Dala Commit Yasak

no-commit-to-branch hook'u, doğrudan main veya master dalına commit yapılmasını engeller. Tüm değişiklikler feature branch üzerinden MR ile gelmelidir.

Ürün Dokümantasyonu

Mon, 01 Jan 0001 00:00:00 +0000

Ürün Dokümantasyonu

Bu sayfa, Denomas ürünlerinin dokümantasyon türlerini, docs-as-code yaklaşımını, versiyon yönetimini ve çeviri sürecini tanımlar.

Doküman Türleri

Tür	Hedef Kitle	İçerik	Güncelleme Sıklığı
API Referansı	Geliştirici	Endpoint tanımları, parametre açıklamaları, örnek istekler/yanıtlar	Her sürümde
Kullanım Rehberi	Son kullanıcı	Adım adım görev tamamlama yönergeleri	Özellik değişikliğinde
Hızlı Başlangıç	Yeni kullanıcı	İlk kurulum ve temel kullanım (15 dakika hedefi)	Büyük sürümlerde
Mimari Dokümanı	Mühendis, mimar	Sistem mimarisi, veri akışı, bileşen ilişkileri	Çeyreklik
Sürüm Notları	Tüm kullanıcılar	Yeni özellikler, düzeltmeler, kırılma değişiklikleri	Her sürümde
Sorun Giderme	Destek, son kullanıcı	Bilinen sorunlar ve çözümleri	Sürekli

Doküman Sorumluluğu

API referansı ve mimari doküman: @muhendislik-ekibi. Kullanım rehberi ve hızlı başlangıç: @urun-ekibi. Sürüm notları: ortak sorumluluk.

Versioning on Denomas Handbook

Kod Kalitesi

Kod Kalitesi

Temel Kural

Pre-commit Hooks

Ürün Dokümantasyonu

Ürün Dokümantasyonu

Doküman Türleri