From 6e87c9f04d048a628af15f257415d5d10b813cb4 Mon Sep 17 00:00:00 2001 From: Ana Wishnoff Date: Wed, 31 Jul 2024 13:30:24 -0400 Subject: [PATCH] Apply suggestions from code review --- .github/ISSUE_TEMPLATE/bug_report.md | 5 +++-- .github/ISSUE_TEMPLATE/documentation.md | 2 ++ .github/ISSUE_TEMPLATE/feature_request.md | 4 ++-- 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index b47873d..969ac3d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -8,12 +8,12 @@ assignees: '' --- **Is this a new bug?** -In other words: Is this an error, flaw, failure or fault? Please search issues to see if someone has already reported the bug you encountered. +In other words: Is this an error, flaw, failure or fault? Please search Github issues and check our [Community Forum](https://community.pinecone.io/) to see if someone has already reported the bug you encountered. If this is a request for help or troubleshooting code in your own Pinecone project, please join the [Pinecone Community Forum](https://community.pinecone.io/). - [ ] I believe this is a new bug -- [ ] I have searched the existing issues, and I could not find an existing issue for this bug +- [ ] I have searched the existing Github issues and Community Forum, and I could not find an existing post for this bug **Describe the bug** Describe the functionality that was working before but is broken now. @@ -25,6 +25,7 @@ If you have one, please include the full stack trace here. If not, please share Include steps to reproduce the issue here. If you have sample code or a script that can be used to replicate this issue, please include that as well (including any dependent files to run the code). **Environment** +* OS Version: * Go version: * Go SDK version: diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md index 3890c04..77f5d9a 100644 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -10,5 +10,7 @@ assignees: '' **Description** Describe the issue that you've encountered with our documentation. +**Suggested solution** +Describe how this issue could be fixed or improved. **Link to page** Add a link to the exact documentation page where the issue occurred. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index e820ba6..693231f 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,8 +7,8 @@ assignees: '' --- -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +**What motivated you to submit this feature request?** +A clear and concise description of why you are requesting this feature - e.g. "Being able to do x would allow me to..." **Describe the solution you'd like** A clear and concise description of what you want to happen.