Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (38 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

58 lines (38 loc) · 2.14 KB
Raw

Contributing to PunycodeSwift

Thanks for your interest in contributing! This document explains how to set up a development environment and submit changes.

Development setup

Requirements:

  • Xcode (see the versions exercised in CI)
  • mise for Ruby/Python toolchain management (optional but recommended)
git clone https://github.com/futamura/PunycodeSwift.git
cd PunycodeSwift
mise install        # installs the Ruby/Python versions from .mise.toml
bundle install      # installs fastlane and other development gems

Building and testing

# SPM
swift build
swift test

# Run a single test method
swift test --filter PunycodeTests/<testMethodName>

# Xcode-based tests for a specific platform (what CI runs)
xcodebuild -project Punycode.xcodeproj -scheme Punycode -destination "platform=macOS" clean test

Fastlane lanes are available for the full matrix (bundle exec fastlane tests), linting (lint_swift), and more — or use the interactive menu: ./run.sh.

Linting

CI enforces formatting with swift-format:

swift-format lint --ignore-unparsable-files --configuration .swift-format --recursive Sources Tests

Run this before pushing; the Lint Code job fails on violations.

Branches and pull requests

  • Base your work on develop and open pull requests against develop.
  • main receives merges from develop; releases are tagged from main.
  • Keep pull requests focused. Include tests for behavior changes — the test suite lives in Tests/PunycodeTests.swift.
  • All CI checks (the CI Success gate) must pass before merging.

Versioning and releases

Releases are handled by maintainers. The version's single source of truth is MARKETING_VERSION in Punycode.xcodeproj/project.pbxproj; set it via bundle exec fastlane set_version / bump_version. Do not edit version numbers by hand in a pull request.

Reporting issues

Use the issue templates. For security vulnerabilities, see SECURITY.md — do not open a public issue.