@deepgram/sdk 1.3.0 → 1.3.1-beta

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (197) hide show
  1. package/.devcontainer/Dockerfile +16 -0
  2. package/.devcontainer/devcontainer.json +29 -0
  3. package/CHANGELOG.md +196 -190
  4. package/CODE_OF_CONDUCT.md +127 -127
  5. package/CONTRIBUTING.md +50 -50
  6. package/LICENSE +21 -21
  7. package/README.md +151 -151
  8. package/dist/billing.d.ts +18 -18
  9. package/dist/billing.js +72 -72
  10. package/dist/billing.js.map +1 -1
  11. package/dist/constants/defaultOptions.d.ts +6 -6
  12. package/dist/constants/defaultOptions.js +9 -9
  13. package/dist/constants/defaultOptions.js.map +0 -0
  14. package/dist/constants/index.d.ts +1 -1
  15. package/dist/constants/index.js +17 -13
  16. package/dist/constants/index.js.map +1 -1
  17. package/dist/enums/alternatives.d.ts +4 -4
  18. package/dist/enums/alternatives.js +2 -2
  19. package/dist/enums/alternatives.js.map +0 -0
  20. package/dist/enums/connectionState.d.ts +6 -6
  21. package/dist/enums/connectionState.js +10 -10
  22. package/dist/enums/connectionState.js.map +0 -0
  23. package/dist/enums/diarization.d.ts +4 -4
  24. package/dist/enums/diarization.js +2 -2
  25. package/dist/enums/diarization.js.map +0 -0
  26. package/dist/enums/index.d.ts +7 -7
  27. package/dist/enums/index.js +23 -19
  28. package/dist/enums/index.js.map +1 -1
  29. package/dist/enums/liveTranscriptionEvents.d.ts +6 -6
  30. package/dist/enums/liveTranscriptionEvents.js +2 -2
  31. package/dist/enums/liveTranscriptionEvents.js.map +0 -0
  32. package/dist/enums/models.d.ts +5 -5
  33. package/dist/enums/models.js +2 -2
  34. package/dist/enums/models.js.map +0 -0
  35. package/dist/enums/punctuation.d.ts +4 -4
  36. package/dist/enums/punctuation.js +2 -2
  37. package/dist/enums/punctuation.js.map +0 -0
  38. package/dist/enums/searchKind.d.ts +4 -4
  39. package/dist/enums/searchKind.js +2 -2
  40. package/dist/enums/searchKind.js.map +0 -0
  41. package/dist/helpers/index.d.ts +1 -1
  42. package/dist/helpers/index.js +17 -13
  43. package/dist/helpers/index.js.map +1 -1
  44. package/dist/helpers/secondsToTimestamp.d.ts +1 -1
  45. package/dist/helpers/secondsToTimestamp.js +7 -7
  46. package/dist/helpers/secondsToTimestamp.js.map +0 -0
  47. package/dist/httpRequest.d.ts +3 -3
  48. package/dist/httpRequest.js +90 -90
  49. package/dist/httpRequest.js.map +1 -1
  50. package/dist/index.d.ts +25 -25
  51. package/dist/index.js +40 -40
  52. package/dist/index.js.map +0 -0
  53. package/dist/invitation.d.ts +29 -29
  54. package/dist/invitation.js +98 -98
  55. package/dist/invitation.js.map +1 -1
  56. package/dist/keys.d.ts +32 -32
  57. package/dist/keys.js +131 -131
  58. package/dist/keys.js.map +1 -1
  59. package/dist/members.d.ts +18 -18
  60. package/dist/members.js +72 -72
  61. package/dist/members.js.map +1 -1
  62. package/dist/projects.d.ts +21 -21
  63. package/dist/projects.js +81 -81
  64. package/dist/projects.js.map +1 -1
  65. package/dist/scopes.d.ts +20 -20
  66. package/dist/scopes.js +76 -76
  67. package/dist/scopes.js.map +1 -1
  68. package/dist/transcription/index.d.ts +18 -18
  69. package/dist/transcription/index.js +71 -71
  70. package/dist/transcription/index.js.map +0 -0
  71. package/dist/transcription/liveTranscription.d.ts +23 -23
  72. package/dist/transcription/liveTranscription.js +82 -82
  73. package/dist/transcription/liveTranscription.js.map +1 -1
  74. package/dist/transcription/preRecordedTranscription.d.ts +8 -8
  75. package/dist/transcription/preRecordedTranscription.js +113 -113
  76. package/dist/transcription/preRecordedTranscription.js.map +1 -1
  77. package/dist/types/balance.d.ts +6 -6
  78. package/dist/types/balance.js +2 -2
  79. package/dist/types/balance.js.map +0 -0
  80. package/dist/types/balanceList.d.ts +4 -4
  81. package/dist/types/balanceList.js +2 -2
  82. package/dist/types/balanceList.js.map +0 -0
  83. package/dist/types/channel.d.ts +25 -25
  84. package/dist/types/channel.js +2 -2
  85. package/dist/types/channel.js.map +0 -0
  86. package/dist/types/createKeyOptions.d.ts +13 -13
  87. package/dist/types/createKeyOptions.js +2 -2
  88. package/dist/types/createKeyOptions.js.map +0 -0
  89. package/dist/types/hit.d.ts +21 -21
  90. package/dist/types/hit.js +2 -2
  91. package/dist/types/hit.js.map +0 -0
  92. package/dist/types/index.d.ts +35 -35
  93. package/dist/types/index.js +51 -47
  94. package/dist/types/index.js.map +1 -1
  95. package/dist/types/invitationList.d.ts +4 -4
  96. package/dist/types/invitationList.js +2 -2
  97. package/dist/types/invitationList.js.map +0 -0
  98. package/dist/types/invitationOptions.d.ts +4 -4
  99. package/dist/types/invitationOptions.js +2 -2
  100. package/dist/types/invitationOptions.js.map +0 -0
  101. package/dist/types/key.d.ts +25 -25
  102. package/dist/types/key.js +2 -2
  103. package/dist/types/key.js.map +0 -0
  104. package/dist/types/keyResponse.d.ts +50 -50
  105. package/dist/types/keyResponse.js +2 -2
  106. package/dist/types/keyResponse.js.map +0 -0
  107. package/dist/types/keyword.d.ts +4 -4
  108. package/dist/types/keyword.js +2 -2
  109. package/dist/types/keyword.js.map +0 -0
  110. package/dist/types/liveTranscriptionOptions.d.ts +148 -148
  111. package/dist/types/liveTranscriptionOptions.js +2 -2
  112. package/dist/types/liveTranscriptionOptions.js.map +0 -0
  113. package/dist/types/liveTranscriptionResponse.d.ts +9 -9
  114. package/dist/types/liveTranscriptionResponse.js +2 -2
  115. package/dist/types/liveTranscriptionResponse.js.map +0 -0
  116. package/dist/types/member.d.ts +7 -7
  117. package/dist/types/member.js +2 -2
  118. package/dist/types/member.js.map +0 -0
  119. package/dist/types/memberList.d.ts +4 -4
  120. package/dist/types/memberList.js +2 -2
  121. package/dist/types/memberList.js.map +0 -0
  122. package/dist/types/message.d.ts +3 -3
  123. package/dist/types/message.js +2 -2
  124. package/dist/types/message.js.map +0 -0
  125. package/dist/types/metadata.d.ts +8 -8
  126. package/dist/types/metadata.js +2 -2
  127. package/dist/types/metadata.js.map +0 -0
  128. package/dist/types/prerecordedTranscriptionOptions.d.ts +126 -126
  129. package/dist/types/prerecordedTranscriptionOptions.js +2 -2
  130. package/dist/types/prerecordedTranscriptionOptions.js.map +0 -0
  131. package/dist/types/prerecordedTranscriptionResponse.d.ts +25 -25
  132. package/dist/types/prerecordedTranscriptionResponse.js +50 -50
  133. package/dist/types/prerecordedTranscriptionResponse.js.map +1 -1
  134. package/dist/types/project.d.ts +17 -17
  135. package/dist/types/project.js +2 -2
  136. package/dist/types/project.js.map +0 -0
  137. package/dist/types/projectPatchResponse.d.ts +6 -6
  138. package/dist/types/projectPatchResponse.js +2 -2
  139. package/dist/types/projectPatchResponse.js.map +0 -0
  140. package/dist/types/projectResponse.d.ts +4 -4
  141. package/dist/types/projectResponse.js +2 -2
  142. package/dist/types/projectResponse.js.map +0 -0
  143. package/dist/types/scopeList.d.ts +3 -3
  144. package/dist/types/scopeList.js +2 -2
  145. package/dist/types/scopeList.js.map +0 -0
  146. package/dist/types/search.d.ts +14 -14
  147. package/dist/types/search.js +2 -2
  148. package/dist/types/search.js.map +0 -0
  149. package/dist/types/transcriptionSource.d.ts +14 -14
  150. package/dist/types/transcriptionSource.js +2 -2
  151. package/dist/types/transcriptionSource.js.map +0 -0
  152. package/dist/types/usageCallback.d.ts +4 -4
  153. package/dist/types/usageCallback.js +2 -2
  154. package/dist/types/usageCallback.js.map +0 -0
  155. package/dist/types/usageField.d.ts +7 -7
  156. package/dist/types/usageField.js +2 -2
  157. package/dist/types/usageField.js.map +0 -0
  158. package/dist/types/usageFieldOptions.d.ts +4 -4
  159. package/dist/types/usageFieldOptions.js +2 -2
  160. package/dist/types/usageFieldOptions.js.map +0 -0
  161. package/dist/types/usageOptions.d.ts +23 -23
  162. package/dist/types/usageOptions.js +2 -2
  163. package/dist/types/usageOptions.js.map +0 -0
  164. package/dist/types/usageRequest.d.ts +11 -11
  165. package/dist/types/usageRequest.js +2 -2
  166. package/dist/types/usageRequest.js.map +0 -0
  167. package/dist/types/usageRequestDetail.d.ts +30 -30
  168. package/dist/types/usageRequestDetail.js +2 -2
  169. package/dist/types/usageRequestDetail.js.map +0 -0
  170. package/dist/types/usageRequestList.d.ts +6 -6
  171. package/dist/types/usageRequestList.js +2 -2
  172. package/dist/types/usageRequestList.js.map +0 -0
  173. package/dist/types/usageRequestListOptions.d.ts +7 -7
  174. package/dist/types/usageRequestListOptions.js +2 -2
  175. package/dist/types/usageRequestListOptions.js.map +0 -0
  176. package/dist/types/usageRequestMessage.d.ts +3 -3
  177. package/dist/types/usageRequestMessage.js +2 -2
  178. package/dist/types/usageRequestMessage.js.map +0 -0
  179. package/dist/types/usageResponse.d.ts +10 -10
  180. package/dist/types/usageResponse.js +2 -2
  181. package/dist/types/usageResponse.js.map +0 -0
  182. package/dist/types/usageResponseDetail.d.ts +6 -6
  183. package/dist/types/usageResponseDetail.js +2 -2
  184. package/dist/types/usageResponseDetail.js.map +0 -0
  185. package/dist/types/utterance.d.ts +39 -39
  186. package/dist/types/utterance.js +2 -2
  187. package/dist/types/utterance.js.map +0 -0
  188. package/dist/types/wordBase.d.ts +8 -8
  189. package/dist/types/wordBase.js +2 -2
  190. package/dist/types/wordBase.js.map +0 -0
  191. package/dist/usage.d.ts +34 -34
  192. package/dist/usage.js +121 -121
  193. package/dist/usage.js.map +1 -1
  194. package/dist/userAgent.d.ts +1 -1
  195. package/dist/userAgent.js +19 -20
  196. package/dist/userAgent.js.map +1 -1
  197. package/package.json +59 -57
@@ -1,128 +1,128 @@
1
- # Contributor Covenant Code of Conduct
2
-
3
- ## Our Pledge
4
-
5
- We as members, contributors, and leaders pledge to make participation in our
6
- community a harassment-free experience for everyone, regardless of age, body
7
- size, visible or invisible disability, ethnicity, sex characteristics, gender
8
- identity and expression, level of experience, education, socio-economic status,
9
- nationality, personal appearance, race, religion, or sexual identity
10
- and orientation.
11
-
12
- We pledge to act and interact in ways that contribute to an open, welcoming,
13
- diverse, inclusive, and healthy community.
14
-
15
- ## Our Standards
16
-
17
- Examples of behavior that contributes to a positive environment for our
18
- community include:
19
-
20
- - Demonstrating empathy and kindness toward other people
21
- - Being respectful of differing opinions, viewpoints, and experiences
22
- - Giving and gracefully accepting constructive feedback
23
- - Accepting responsibility and apologizing to those affected by our mistakes,
24
- and learning from the experience
25
- - Focusing on what is best not just for us as individuals, but for the
26
- overall community
27
-
28
- Examples of unacceptable behavior include:
29
-
30
- - The use of sexualized language or imagery, and sexual attention or
31
- advances of any kind
32
- - Trolling, insulting or derogatory comments, and personal or political attacks
33
- - Public or private harassment
34
- - Publishing others' private information, such as a physical or email
35
- address, without their explicit permission
36
- - Other conduct which could reasonably be considered inappropriate in a
37
- professional setting
38
-
39
- ## Enforcement Responsibilities
40
-
41
- Community leaders are responsible for clarifying and enforcing our standards of
42
- acceptable behavior and will take appropriate and fair corrective action in
43
- response to any behavior that they deem inappropriate, threatening, offensive,
44
- or harmful.
45
-
46
- Community leaders have the right and responsibility to remove, edit, or reject
47
- comments, commits, code, wiki edits, issues, and other contributions that are
48
- not aligned to this Code of Conduct, and will communicate reasons for moderation
49
- decisions when appropriate.
50
-
51
- ## Scope
52
-
53
- This Code of Conduct applies within all community spaces, and also applies when
54
- an individual is officially representing the community in public spaces.
55
- Examples of representing our community include using an official e-mail address,
56
- posting via an official social media account, or acting as an appointed
57
- representative at an online or offline event.
58
-
59
- ## Enforcement
60
-
61
- Instances of abusive, harassing, or otherwise unacceptable behavior may be
62
- reported to the community leaders responsible for enforcement at
63
- devrel@deepgram.com.
64
- All complaints will be reviewed and investigated promptly and fairly.
65
-
66
- All community leaders are obligated to respect the privacy and security of the
67
- reporter of any incident.
68
-
69
- ## Enforcement Guidelines
70
-
71
- Community leaders will follow these Community Impact Guidelines in determining
72
- the consequences for any action they deem in violation of this Code of Conduct:
73
-
74
- ### 1. Correction
75
-
76
- **Community Impact**: Use of inappropriate language or other behavior deemed
77
- unprofessional or unwelcome in the community.
78
-
79
- **Consequence**: A private, written warning from community leaders, providing
80
- clarity around the nature of the violation and an explanation of why the
81
- behavior was inappropriate. A public apology may be requested.
82
-
83
- ### 2. Warning
84
-
85
- **Community Impact**: A violation through a single incident or series
86
- of actions.
87
-
88
- **Consequence**: A warning with consequences for continued behavior. No
89
- interaction with the people involved, including unsolicited interaction with
90
- those enforcing the Code of Conduct, for a specified period of time. This
91
- includes avoiding interactions in community spaces as well as external channels
92
- like social media. Violating these terms may lead to a temporary or
93
- permanent ban.
94
-
95
- ### 3. Temporary Ban
96
-
97
- **Community Impact**: A serious violation of community standards, including
98
- sustained inappropriate behavior.
99
-
100
- **Consequence**: A temporary ban from any sort of interaction or public
101
- communication with the community for a specified period of time. No public or
102
- private interaction with the people involved, including unsolicited interaction
103
- with those enforcing the Code of Conduct, is allowed during this period.
104
- Violating these terms may lead to a permanent ban.
105
-
106
- ### 4. Permanent Ban
107
-
108
- **Community Impact**: Demonstrating a pattern of violation of community
109
- standards, including sustained inappropriate behavior, harassment of an
110
- individual, or aggression toward or disparagement of classes of individuals.
111
-
112
- **Consequence**: A permanent ban from any sort of public interaction within
113
- the community.
114
-
115
- ## Attribution
116
-
117
- This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118
- version 2.0, available at
119
- https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120
-
121
- Community Impact Guidelines were inspired by [Mozilla's code of conduct
122
- enforcement ladder](https://github.com/mozilla/diversity).
123
-
124
- [homepage]: https://www.contributor-covenant.org
125
-
126
- For answers to common questions about this code of conduct, see the FAQ at
127
- https://www.contributor-covenant.org/faq. Translations are available at
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our
6
+ community a harassment-free experience for everyone, regardless of age, body
7
+ size, visible or invisible disability, ethnicity, sex characteristics, gender
8
+ identity and expression, level of experience, education, socio-economic status,
9
+ nationality, personal appearance, race, religion, or sexual identity
10
+ and orientation.
11
+
12
+ We pledge to act and interact in ways that contribute to an open, welcoming,
13
+ diverse, inclusive, and healthy community.
14
+
15
+ ## Our Standards
16
+
17
+ Examples of behavior that contributes to a positive environment for our
18
+ community include:
19
+
20
+ - Demonstrating empathy and kindness toward other people
21
+ - Being respectful of differing opinions, viewpoints, and experiences
22
+ - Giving and gracefully accepting constructive feedback
23
+ - Accepting responsibility and apologizing to those affected by our mistakes,
24
+ and learning from the experience
25
+ - Focusing on what is best not just for us as individuals, but for the
26
+ overall community
27
+
28
+ Examples of unacceptable behavior include:
29
+
30
+ - The use of sexualized language or imagery, and sexual attention or
31
+ advances of any kind
32
+ - Trolling, insulting or derogatory comments, and personal or political attacks
33
+ - Public or private harassment
34
+ - Publishing others' private information, such as a physical or email
35
+ address, without their explicit permission
36
+ - Other conduct which could reasonably be considered inappropriate in a
37
+ professional setting
38
+
39
+ ## Enforcement Responsibilities
40
+
41
+ Community leaders are responsible for clarifying and enforcing our standards of
42
+ acceptable behavior and will take appropriate and fair corrective action in
43
+ response to any behavior that they deem inappropriate, threatening, offensive,
44
+ or harmful.
45
+
46
+ Community leaders have the right and responsibility to remove, edit, or reject
47
+ comments, commits, code, wiki edits, issues, and other contributions that are
48
+ not aligned to this Code of Conduct, and will communicate reasons for moderation
49
+ decisions when appropriate.
50
+
51
+ ## Scope
52
+
53
+ This Code of Conduct applies within all community spaces, and also applies when
54
+ an individual is officially representing the community in public spaces.
55
+ Examples of representing our community include using an official e-mail address,
56
+ posting via an official social media account, or acting as an appointed
57
+ representative at an online or offline event.
58
+
59
+ ## Enforcement
60
+
61
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
62
+ reported to the community leaders responsible for enforcement at
63
+ devrel@deepgram.com.
64
+ All complaints will be reviewed and investigated promptly and fairly.
65
+
66
+ All community leaders are obligated to respect the privacy and security of the
67
+ reporter of any incident.
68
+
69
+ ## Enforcement Guidelines
70
+
71
+ Community leaders will follow these Community Impact Guidelines in determining
72
+ the consequences for any action they deem in violation of this Code of Conduct:
73
+
74
+ ### 1. Correction
75
+
76
+ **Community Impact**: Use of inappropriate language or other behavior deemed
77
+ unprofessional or unwelcome in the community.
78
+
79
+ **Consequence**: A private, written warning from community leaders, providing
80
+ clarity around the nature of the violation and an explanation of why the
81
+ behavior was inappropriate. A public apology may be requested.
82
+
83
+ ### 2. Warning
84
+
85
+ **Community Impact**: A violation through a single incident or series
86
+ of actions.
87
+
88
+ **Consequence**: A warning with consequences for continued behavior. No
89
+ interaction with the people involved, including unsolicited interaction with
90
+ those enforcing the Code of Conduct, for a specified period of time. This
91
+ includes avoiding interactions in community spaces as well as external channels
92
+ like social media. Violating these terms may lead to a temporary or
93
+ permanent ban.
94
+
95
+ ### 3. Temporary Ban
96
+
97
+ **Community Impact**: A serious violation of community standards, including
98
+ sustained inappropriate behavior.
99
+
100
+ **Consequence**: A temporary ban from any sort of interaction or public
101
+ communication with the community for a specified period of time. No public or
102
+ private interaction with the people involved, including unsolicited interaction
103
+ with those enforcing the Code of Conduct, is allowed during this period.
104
+ Violating these terms may lead to a permanent ban.
105
+
106
+ ### 4. Permanent Ban
107
+
108
+ **Community Impact**: Demonstrating a pattern of violation of community
109
+ standards, including sustained inappropriate behavior, harassment of an
110
+ individual, or aggression toward or disparagement of classes of individuals.
111
+
112
+ **Consequence**: A permanent ban from any sort of public interaction within
113
+ the community.
114
+
115
+ ## Attribution
116
+
117
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118
+ version 2.0, available at
119
+ https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120
+
121
+ Community Impact Guidelines were inspired by [Mozilla's code of conduct
122
+ enforcement ladder](https://github.com/mozilla/diversity).
123
+
124
+ [homepage]: https://www.contributor-covenant.org
125
+
126
+ For answers to common questions about this code of conduct, see the FAQ at
127
+ https://www.contributor-covenant.org/faq. Translations are available at
128
128
  https://www.contributor-covenant.org/translations.
package/CONTRIBUTING.md CHANGED
@@ -1,50 +1,50 @@
1
- # Contributing Guidelines
2
-
3
- Want to contribute to this project? We ❤️ it!
4
-
5
- Here are a few types of contributions that we would be interested in hearing about.
6
-
7
- - Bug fixes
8
- - If you find a bug, please first report it using Github Issues.
9
- - Issues that have already been identified as a bug will be labeled `🐛 bug`.
10
- - If you'd like to submit a fix for a bug, send a Pull Request from your own fork and mention the Issue number.
11
- - Include a test that isolates the bug and verifies that it was fixed.
12
- - New Features
13
- - If you'd like to accomplish something in the extension that it doesn't already do, describe the problem in a new Github Issue.
14
- - Issues that have been identified as a feature request will be labeled `✨ enhancement`.
15
- - If you'd like to implement the new feature, please wait for feedback from the project maintainers before spending
16
- too much time writing the code. In some cases, `✨ enhancement`s may not align well with the project objectives at
17
- the time.
18
- - Tests, Documentation, Miscellaneous
19
- - If you think the test coverage could be improved, the documentation could be clearer, you've got an alternative
20
- implementation of something that may have more advantages, or any other change we would still be glad hear about
21
- it.
22
- - If its a trivial change, go ahead and send a Pull Request with the changes you have in mind
23
- - If not, open a Github Issue to discuss the idea first.
24
- - Snippets
25
- - To add snippets:
26
- - Add a directory in the `snippets` folder with the name of the language.
27
- - Add one or more files in the language directory with snippets.
28
- - Update the `package.json` to include the snippets you added.
29
-
30
- We also welcome anyone to work on any existing issues with the `👋🏽 good first issue` tag.
31
-
32
- ## Requirements
33
-
34
- For a contribution to be accepted:
35
-
36
- - The test suite must be complete and pass
37
- - Code must follow existing styling conventions
38
- - Commit messages must be descriptive. Related issues should be mentioned by number.
39
-
40
- If the contribution doesn't meet these criteria, a maintainer will discuss it with you on the Issue. You can still
41
- continue to add more commits to the branch you have sent the Pull Request from.
42
-
43
- ## How To
44
-
45
- 1. Fork this repository on GitHub.
46
- 1. Clone/fetch your fork to your local development machine.
47
- 1. Create a new branch (e.g. `issue-12`, `feat.add_foo`, etc) and check it out.
48
- 1. Make your changes and commit them. (Did the tests pass? No linting errors?)
49
- 1. Push your new branch to your fork. (e.g. `git push myname issue-12`)
50
- 1. Open a Pull Request from your new branch to the original fork's `main` branch.
1
+ # Contributing Guidelines
2
+
3
+ Want to contribute to this project? We ❤️ it!
4
+
5
+ Here are a few types of contributions that we would be interested in hearing about.
6
+
7
+ - Bug fixes
8
+ - If you find a bug, please first report it using Github Issues.
9
+ - Issues that have already been identified as a bug will be labeled `🐛 bug`.
10
+ - If you'd like to submit a fix for a bug, send a Pull Request from your own fork and mention the Issue number.
11
+ - Include a test that isolates the bug and verifies that it was fixed.
12
+ - New Features
13
+ - If you'd like to accomplish something in the extension that it doesn't already do, describe the problem in a new Github Issue.
14
+ - Issues that have been identified as a feature request will be labeled `✨ enhancement`.
15
+ - If you'd like to implement the new feature, please wait for feedback from the project maintainers before spending
16
+ too much time writing the code. In some cases, `✨ enhancement`s may not align well with the project objectives at
17
+ the time.
18
+ - Tests, Documentation, Miscellaneous
19
+ - If you think the test coverage could be improved, the documentation could be clearer, you've got an alternative
20
+ implementation of something that may have more advantages, or any other change we would still be glad hear about
21
+ it.
22
+ - If its a trivial change, go ahead and send a Pull Request with the changes you have in mind
23
+ - If not, open a Github Issue to discuss the idea first.
24
+ - Snippets
25
+ - To add snippets:
26
+ - Add a directory in the `snippets` folder with the name of the language.
27
+ - Add one or more files in the language directory with snippets.
28
+ - Update the `package.json` to include the snippets you added.
29
+
30
+ We also welcome anyone to work on any existing issues with the `👋🏽 good first issue` tag.
31
+
32
+ ## Requirements
33
+
34
+ For a contribution to be accepted:
35
+
36
+ - The test suite must be complete and pass
37
+ - Code must follow existing styling conventions
38
+ - Commit messages must be descriptive. Related issues should be mentioned by number.
39
+
40
+ If the contribution doesn't meet these criteria, a maintainer will discuss it with you on the Issue. You can still
41
+ continue to add more commits to the branch you have sent the Pull Request from.
42
+
43
+ ## How To
44
+
45
+ 1. Fork this repository on GitHub.
46
+ 1. Clone/fetch your fork to your local development machine.
47
+ 1. Create a new branch (e.g. `issue-12`, `feat.add_foo`, etc) and check it out.
48
+ 1. Make your changes and commit them. (Did the tests pass? No linting errors?)
49
+ 1. Push your new branch to your fork. (e.g. `git push myname issue-12`)
50
+ 1. Open a Pull Request from your new branch to the original fork's `main` branch.
package/LICENSE CHANGED
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2021 deepgram
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ MIT License
2
+
3
+ Copyright (c) 2021 deepgram
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.