Skip to content
This repository has been archived by the owner on Nov 27, 2023. It is now read-only.

Commit

Permalink
GitHub: update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
chris-araman committed Mar 3, 2021
1 parent f3255c3 commit 98aecbc
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 0 deletions.
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
name: Bug report
about: Create a report to help improve CombineCloudKit
title: ":bug: "
labels: bug
assignees: chris-araman

---

**Describe the bug**
A clear and concise description of the problem.

**How to reproduce**
Steps to follow to reproduce the problem:
1. Do a thing.
1. Then do this.
1. Then this.

Please include sample code that reproduces the problem.
```swift
database
.performQuery(ofType: "ToDoItem", where: NSPredicate(true))
.sink { records in
XCTAssertGreaterThan(records.count, 0)
}
```

**Expected behavior**
A clear and concise description of what happened that you did not expect to happen.
> CombineCloudKit does not return any `CKRecord` results. The assertion fails.
**Expected behavior**
A clear and concise description of what you expected to happen.
> I expect to receive at least one `CKRecord` in `sink`.
**Environment**
- CombineCloudKit version
- Platform version
- Swift version
- Xcode version
> CombineCloudKit 0.1.0, macOS Catalyst 11.2, Swift 5.3, Xcode 12.4
**Additional context**
Any other context about the problem.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Feature request
about: Suggest a new feature or enhancement for CombineCloudKit
title: ":sparkles: "
labels: enhancement
assignees: chris-araman

---

**Problem statement**
A clear and concise description of what the problem is.
> CombineCloudKit doesn't yet support X.
**Proposed solution**
A clear and concise description of what you want to happen.
> Implement support for X using Y and Z.
**Alternatives considered**
A clear and concise description of any alternative solutions you've considered.

**Additional context**
Add any other context about the feature request here.

0 comments on commit 98aecbc

Please sign in to comment.