Merge pull request #213 from dvonthenen/update-issue-pr-templates

Update Issue/PR Templates

.github/CODE_OF_CONDUCT.md

@@ -128,4 +128,4 @@ This Code of Conduct is adapted from:
 
 Community Impact Guidelines, which were copied from InnerSource Commons, were inspired by Mozilla’s code of conduct enforcement ladder.
 
-For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
+For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

.github/CONTRIBUTING.md

@@ -6,29 +6,34 @@ Here are a few types of contributions that we would be interested in hearing abo
 
 * Bug fixes
   * If you find a bug, please first report it using Github Issues.
-  * Issues that have already been identified as a bug will be labeled `bug`.
+  * Issues that have already been identified as a bug will be labeled `🐛 bug`.
     * If you'd like to submit a fix for a bug, send a Pull Request from your own fork and mention the Issue number.
       * Include a test that isolates the bug and verifies that it was fixed.
 * New Features
   * If you'd like to accomplish something in the extension that it doesn't already do, describe the problem in a new Github Issue.
-    * Issues that have been identified as a feature request will be labeled `enhancement`.
+    * Issues that have been identified as a feature request will be labeled `✨ enhancement`.
     * If you'd like to implement the new feature, please wait for feedback from the project maintainers before spending
-      too much time writing the code. In some cases, `enhancement`s may not align well with the project objectives at
+      too much time writing the code. In some cases, `✨ enhancement`s may not align well with the project objectives at
       the time.
 * Tests, Documentation, Miscellaneous
   * If you think the test coverage could be improved, the documentation could be clearer, you've got an alternative
     implementation of something that may have more advantages, or any other change we would still be glad hear about
     it.
     * If its a trivial change, go ahead and send a Pull Request with the changes you have in mind
     * If not, open a Github Issue to discuss the idea first.
+* Snippets
+  * To add snippets:
+    * Add a directory in the `snippets` folder with the name of the language.
+    * Add one or more files in the language directory with snippets.
+    * Update the `package.json` to include the snippets you added.
 
-We also welcome anyone to work on any existing issues with the `good first issue` tag.
+We also welcome anyone to work on any existing issues with the `👋🏽 good first issue` tag.
 
 ## Requirements
 
 For a contribution to be accepted:
 
-* The test suite must be complete and pass
+* The test suite must be complete and pass. Run `pytest --api-key <key> tests/`
 * Code must follow existing styling conventions
 * Commit messages must be descriptive. Related issues should be mentioned by number.
 

.github/ISSUE_TEMPLATE/bug_report.md

@@ -8,25 +8,34 @@ assignees: ''
 ---
 
 ## What is the current behavior?
+<!--
+What's happening that seems wrong?
+-->
 
-> What's happening that seems wrong?
 
 ## Steps to reproduce
+<!--
+To make it faster to diagnose the root problem. Tell us how can we reproduce the bug.
+-->
 
-> To make it faster to diagnose the root problem. Tell us how can we reproduce the bug.
 
 ## Expected behavior
+<!--
+What would you expect to happen when following the steps above?
+-->
 
-> What would you expect to happen when following the steps above?
 
 ## Please tell us about your environment
-
-> We want to make sure the problem isn't specific to your operating system or programming language.
+<!--
+We want to make sure the problem isn't specific to your operating system or programming language.
   
-- **Operating System/Version:** Windows 10
-- **Language:** [all | TypeScript | Python | PHP | etc]
-- **Browser:** Chrome
+- **Operating System/Version:** (ex. MacOS 14.2, Windows 10, RHEL 6, etc)
+- **Go Version:** (ex. v1.18)
+-->
+
 
 ## Other information
+<!--
+Anything else we should know? (e.g. detailed explanation, stack-traces, related issues, suggestions how to fix, links for us to have context, eg. stack overflow, codepen, etc)
+-->
 
-> Anything else we should know? (e.g. detailed explanation, stack-traces, related issues, suggestions how to fix, links for us to have context, eg. stack overflow, codepen, etc)

.github/ISSUE_TEMPLATE/config.yml

@@ -3,4 +3,4 @@ contact_links:
   - name: Deepgram Developer Community
     url: https://github.com/orgs/deepgram/discussions
   - name: Deepgram on Twitter
-    url: https://twitter.com/DeepgramAI
+    url: https://twitter.com/DeepgramAI

.github/ISSUE_TEMPLATE/feature-request.md

@@ -8,17 +8,25 @@ assignees: ''
 ---
 
 ## Proposed changes
+<!--
+Provide a detailed description of the change or addition you are proposing
+-->
 
-> Provide a detailed description of the change or addition you are proposing
 
 ## Context
+<!--
+Why is this change important to you? How would you use it? How can it benefit other users?
+-->
 
-> Why is this change important to you? How would you use it? How can it benefit other users?
 
 ## Possible Implementation
+<!--
+Not obligatory, but suggest an idea for implementing addition or change
+-->
 
-> Not obligatory, but suggest an idea for implementing addition or change
 
 ## Other information
+<!--
+Anything else we should know? (e.g. detailed explanation, related issues, links for us to have context, eg. stack overflow, codepen, etc)
+-->
 
-> Anything else we should know? (e.g. detailed explanation, related issues, links for us to have context, eg. stack overflow, codepen, etc)

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -1,10 +1,12 @@
-## Proposed Changes
-
+## Proposed changes
+<!--
 Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue.
+-->
+
 
-## Types of Changes
+## Types of changes
 
-What types of changes does your code introduce to the Vonage for Visual Studio Code extension?
+What types of changes does your code introduce to the community .NET SDK?
 _Put an `x` in the boxes that apply_
 
 - [ ] Bugfix (non-breaking change which fixes an issue)
@@ -16,12 +18,13 @@ _Put an `x` in the boxes that apply_
 
 _Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._
 
-- [ ] I have read the [CONTRIBUTING](../../CONTRIBUTING.md) doc
-- [ ] Lint and unit tests pass locally with my changes
+- [ ] I have read the [CONTRIBUTING](../CONTRIBUTING.md) doc
+- [ ] I have lint'ed all of my code using repo standards
 - [ ] I have added tests that prove my fix is effective or that my feature works
 - [ ] I have added necessary documentation (if appropriate)
-- [ ] Any dependent changes have been merged and published in downstream modules
 
-## Further Comments
+## Further comments
+<!--
+If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...
+-->
 
-If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...