Development Guide

🔧 Development Guide

Copyright © 2026 MWBM Partners Ltd. All rights reserved.

Code Standards

Copyright Headers

Every Swift file must begin with:

// ============================================================================
// MeedyaConverter — [File Description]
// Copyright © 2026–2026 MWBM Partners Ltd. All rights reserved.
// Proprietary and confidential. Unauthorized copying or distribution
// of this file, via any medium, is strictly prohibited.
// ============================================================================

Annotations

• Every code block must have detailed comments explaining what it does and why
• Use full descriptions, not abbreviated annotations
• Include MARK: sections for file organization
• Document all public APIs with Swift doc comments (///)

Swift Conventions

• Swift 6.3 with strict concurrency checking
• Prefer async/await over callbacks
• Use Sendable conformance where required
• Follow Swift API Design Guidelines

Branch Strategy

Branch	Purpose	Release Tags
main	Stable production releases	vX.Y.Z
beta	Beta testing	vX.Y.Z-beta.N
alpha	Active development	vX.Y.Z-alpha.N

Commit Messages

Follow conventional commit format:

type(scope): brief description

Detailed body explaining what and why.

Co-Authored-By: Developer Name <email>

Types: feat, fix, docs, refactor, test, chore, build, ci

Pull Request Process

1. Create a GitHub Issue first (or reference an existing one)
2. Branch from alpha for features, beta for fixes
3. Write code following all standards above
4. Ensure swift build and swift test pass with zero failures
5. Run lint checks — resolve all warnings
6. Create PR with the provided template
7. Link the relevant GitHub Issue(s)

Testing Requirements

• All public API must have unit tests
• Test files go in Tests/ConverterEngineTests/ or Tests/MeedyaConvertTests/
• Use XCTest framework
• Aim for meaningful coverage, not just line coverage

Standing Tasks

After every development action, these tasks are mandatory:

1. Create/update GitHub Issue
2. Lint/syntax check loop (repeat until clean)
3. Security check loop (repeat until clean)
4. Update all documentation (.md files)
5. Update GitHub Issues, Milestones, Project, Wiki
6. Commit (do NOT push — push is manual)