Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add issue template #711

Merged
merged 3 commits into from Jun 14, 2018
Merged

Add issue template #711

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8fcba1a
Add issue template
funkyboy Apr 5, 2018
9d1b47f
Improve explanation for Enterprise customers
funkyboy Apr 6, 2018
c8b34f8
Add link to support guide
funkyboy Jun 14, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
37 changes: 37 additions & 0 deletions .github/issue_template.md
View file
Open in desktop
@@ -0,0 +1,37 @@
### Which version of the Ably SDK are you using?
E.g. `1.0.11`

### On which platform does the issue happen?
E.g. `iOS11`

### Are you using Carthage?
If yes, specify the version (`carthage version`)

### Are you using Cocoapods?
If yes, specify the version (`pod --version`)

### Which version of Xcode are you using?
(`xcodebuild -version`)

### What did you do?
Describe the problem.
```
Add a short snippet of code to show the problem
```

### What did you expect to happen?
Describe the expected outcome.

### What happened instead?
Describe what happened instead.

```
Add relevant console logs.
```

**Tip:** set the log level to debug. E.g. `realtime.logger.logLevel = .debug`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we perhaps recommend people first take a look at https://support.ably.io/solution/articles/3000063743-guide-information-we-need-to-help-you-diagnose-problems? This may help them solve some problems themselves, especially when we improve the support section.

Additionally, should we not ask them for their app and key ID?

Copy link
Contributor Author

@funkyboy funkyboy Apr 6, 2018 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mattheworiordan

https://support.ably.io/solution/articles/3000063743-guide-information-we-need-to-help-you-diagnose-problems seems quite biased towards JS. We can link to that but I'd still keep the "setting debug logLevel" tip and the one liner example.

About asking app ID see: https://ably-real-time.slack.com/archives/C030APSH3/p1522946396000289


### Link to sample project
Feel free to link to a sample project that showcases the issue.

P.S. If you are an [Ably Enterprise customer](https://www.ably.io/pricing/enterprise), please [get in touch](https://www.ably.io/contact) with a link to this issue to get prioritized support.