Skip to content

v0.0.2 - Breaking Change: Issue → Feedback

Choose a tag to compare

@noppefoxwolf noppefoxwolf released this 05 Jul 00:41
· 9 commits to main since this release
534bf66

FeedbackAssistant v0.0.2 - Breaking Change: Issue → Feedback

🚨 Breaking Changes

This release contains breaking changes that require code updates.

Issue → Feedback Rename

To avoid naming conflicts and provide clearer API semantics, the main data model has been renamed:

  • Class: Issue → Feedback
  • File: Issue.swift → Feedback.swift
  • Parameters: initialIssue → initialFeedback
  • Protocol: submitFeedback(_ issue: Issue) → submitFeedback(_ feedback: Feedback)

Migration Guide

Before (v0.0.1):

// Old API
FeedbackAssistantView(
    submissionHandler: handler,
    initialIssue: Issue(title: "Bug report")
)

class MyHandler: FeedbackSubmissionProtocol {
    func submitFeedback(_ issue: Issue) async throws {
        // Handle issue
    }
}

After (v0.0.2):

// New API
FeedbackAssistantView(
    submissionHandler: handler,
    initialFeedback: Feedback(title: "Bug report")
)

class MyHandler: FeedbackSubmissionProtocol {
    func submitFeedback(_ feedback: Feedback) async throws {
        // Handle feedback
    }
}

✨ Benefits

  • Clearer semantics - Feedback better describes the purpose than generic Issue
  • Avoid conflicts - Reduces potential naming conflicts with other libraries
  • Better API - More intuitive and self-documenting interface

📋 Requirements

  • iOS 17.0+
  • Swift 6.0+
  • Xcode 16.0+

📦 Installation

dependencies: [
    .package(url: "https://github.com/noppefoxwolf/FeedbackAssistant.git", from: "0.0.2")
]

🤖 Generated with Claude Code