Skip to content

Latest commit

 

History

History
38 lines (25 loc) · 893 Bytes

File metadata and controls

38 lines (25 loc) · 893 Bytes

Contributing to SwiftSQL

SwiftSQL is intentionally small, explicit, and conservative. Thanks for keeping it that way.

Local build and tests

dotnet build
dotnet run -c Release --project SwiftSQL.Tests/SwiftSQL.Tests.csproj

Coding style

  • Clarity and predictability over cleverness
  • Keep async APIs async-only
  • Avoid shared mutable state
  • Keep the public API surface minimal and intentional

Public API changes

  • Breaking changes require discussion before a PR
  • If behavior must change, document the impact and migration path

Issues and pull requests

  • File issues with clear steps or a minimal repro
  • Keep PRs focused and explain why the change is needed
  • Avoid unrelated refactors

Branching

  • main is stable and release-ready
  • Features and fixes land via PRs

Testing expectations

  • New code must include tests
  • All tests must pass before review