Skip to content

Commit 3479ddd

Browse files
committed
build: added github templates for issues and how-to
1 parent d8dca46 commit 3479ddd

File tree

4 files changed

+85
-49
lines changed

4 files changed

+85
-49
lines changed

.github/ISSUE_TEMPLATE.md

-30
This file was deleted.

.github/ISSUE_TEMPLATE/NEW-ISSUE.yml

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
name: Bug Report
3+
description: File a bug report
4+
title: "[Bug]: "
5+
labels: ["bug", "Triage"]
6+
assignees: ["manchuck", "pardel", "dragonmantank"]
7+
body:
8+
- type: dropdown
9+
id: node_version
10+
attributes:
11+
label: Node Version
12+
description: What version of NodeJS are you using?
13+
options:
14+
- 18.x
15+
- 20.x
16+
- 22.x
17+
validations:
18+
required: true
19+
- type: dropdown
20+
id: platform
21+
attributes:
22+
label: Platform
23+
description: What is the platform you are having the issue on?
24+
multiple: true
25+
options:
26+
- "Windows"
27+
- "Linux"
28+
- "Mac (intel)"
29+
- "Mac (Apple Silcon)"
30+
- "Docker Container"
31+
validations:
32+
required: true
33+
- type: input
34+
id: sdk_version
35+
attributes:
36+
label: SDK Version
37+
description: What version of the SDK are you using?
38+
placeholder: 3.x.x
39+
validations:
40+
required: true
41+
- type: textarea
42+
id: code_sample
43+
attributes:
44+
label: Code Sample
45+
description: Please provide a sample of the code
46+
validations:
47+
required: true
48+
- type: textarea
49+
id: expected_behavior
50+
attributes:
51+
label: Expected Behavior
52+
description: Please provide a brief description of what you wanted to
53+
happen
54+
validations:
55+
required: true
56+
- type: textarea
57+
id: actual_behavior
58+
attributes:
59+
label: Actual Behavior
60+
description: Please provide a brief description of what happened
61+
validations:
62+
required: true

.github/ISSUE_TEMPLATE/config.yml

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
---
2+
blank_issues_enabled: false

README.md

+21-19
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,30 @@
22

33
<img src="https://developer.nexmo.com/images/logos/vbc-logo.svg" height="48px"/>
44

5-
Quickstarts also available for:
6-
[Python](https://github.com/Vonage/vonage-python-code-snippets),
7-
[.NET](https://github.com/Vonage/vonage-dotnet-code-snippets),
8-
[Node.js](https://github.com/Vonage/vonage-node-code-snippets),
9-
[PHP](https://github.com/Vonage/vonage-php-code-snippets),
10-
[Ruby](https://github.com/Vonage/vonage-ruby-code-snippets) and
5+
Quickstarts also available for:
6+
[Python](https://github.com/Vonage/vonage-python-code-snippets),
7+
[.NET](https://github.com/Vonage/vonage-dotnet-code-snippets),
8+
[Node.js](https://github.com/Vonage/vonage-node-code-snippets),
9+
[PHP](https://github.com/Vonage/vonage-php-code-snippets),
10+
[Ruby](https://github.com/Vonage/vonage-ruby-code-snippets) and
1111
[cURL](https://github.com/Vonage/vonage-curl-code-snippets).
1212

13-
These code samples are meant to be used for
14-
[https://developer.nexmo.com/](https://developer.nexmo.com/), and are
15-
structured in such a way as to be used for internal testing. Developers are
16-
free to use these code snippets as a reference, but these may require changes
17-
to be worked into your specific application. We recommend checking out the
18-
[Vonage API Developer Website](https://developer.nexmo.com/), which displays
13+
These code samples are meant to be used for
14+
[https://developer.nexmo.com/](https://developer.nexmo.com/), and are
15+
structured in such a way as to be used for internal testing. Developers are
16+
free to use these code snippets as a reference, but these may require changes
17+
to be worked into your specific application. We recommend checking out the
18+
[Vonage API Developer Website](https://developer.nexmo.com/), which displays
1919
these code snippets in a more copy/paste fashion.
2020

2121
## Configure with Your Vonage API Keys
2222

23-
If you'd still like to use this sample you will first need a
24-
[Vonage account](https://dashboard.nexmo.com/sign-up). Once you have your own
25-
API credentials, rename the `.env-example` file to `.env` and set the values
23+
If you'd still like to use this sample you will first need a
24+
[Vonage account](https://dashboard.nexmo.com/sign-up). Once you have your own
25+
API credentials, rename the `.env-example` file to `.env` and set the values
2626
as required.
2727

28-
For some of the examples, you will need to
28+
For some of the examples, you will need to
2929
[buy a number](https://dashboard.nexmo.com/buy-numbers).
3030

3131
## Tutorials & Sample Code
@@ -56,9 +56,11 @@ For some of the examples, you will need to
5656

5757
## Request More Examples
5858

59-
Please [raise an issue](https://github.com/Vonage/vonage-node-sdk/issues) to
60-
request an example that isn't present within the quickstart. Pull requests
61-
will be gratefully received.
59+
[raise an issue](/../../issues/) if there is a an issue with the code.
60+
61+
If you want to know how to do something specific with the Vonage APIs,
62+
Please [ask a question](https://github.com/Vonage/vonage-node-sdk/issues) in
63+
the Node SDK repo.
6264

6365
## Licenses
6466

0 commit comments

Comments
 (0)