diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml deleted file mode 100644 index 52030067..00000000 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ /dev/null @@ -1,78 +0,0 @@ -name: 🐞 Bug -description: Report a bug or an issue you've found with the Pinecone Python client -title: "[Bug] " -labels: ["bug", "triage"] -body: - - type: markdown - attributes: - value: | - Thanks for taking the time to fill out this bug report! - - type: checkboxes - attributes: - label: Is this a new bug in the Pinecone Python client? - description: > - In other words, is this an error, flaw, failure or fault in the Python client? - - 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/) - - Please search to see if an issue already exists for the bug you encountered. - options: - - label: I believe this is a new bug in the Pinecone Python Client - required: true - - label: I have searched the existing issues, and I could not find an existing issue for this bug - required: true - - type: textarea - attributes: - label: Current Behavior - description: A concise description of what you're experiencing. - validations: - required: true - - type: textarea - attributes: - label: Expected Behavior - description: A concise description of what you expected to happen. - validations: - required: true - - type: textarea - attributes: - label: Steps To Reproduce - description: Steps to reproduce the behavior. - placeholder: | - 1. In this environment... - 2. With this config... - 3. Run '...' - 4. See error... - validations: - required: true - - type: textarea - id: logs - attributes: - label: Relevant log output - description: | - If applicable, log output to help explain your problem. - render: shell - validations: - required: false - - type: textarea - attributes: - label: Environment - description: | - examples: - - **OS**: Ubuntu 20.04 - - **Python**: 3.9.12 (`python3 --version`) - - **pinecone**: 2.2.1 - value: | - - OS: - - Python: - - pinecone: - render: markdown - validations: - required: false - - type: textarea - attributes: - label: Additional Context - description: | - Links? References? Anything that will give us more context about the issue you are encountering! - - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..c3bea26b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,33 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "[Bug] " +labels: bug +assignees: '' + +--- + +**Is this a new bug?** +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 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. + +**Error information** +If you have one, please include the full stack trace here. If not, please share as much as you can about the error. + +**Steps to reproduce the issue locally** +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: +* Python version: +* Python SDK version: + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..aea4f695 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Pinecone Community Forum + url: https://community.pinecone.io/ + about: For support, please see the community forum. diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 00000000..903c1459 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,17 @@ +--- +name: Documentation +about: Report an issue in our docs +title: "[Docs] " +labels: 'documentation' +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.yml b/.github/ISSUE_TEMPLATE/feature-request.yml deleted file mode 100644 index cef5f433..00000000 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ /dev/null @@ -1,54 +0,0 @@ -name: ✨ Feature -description: Propose a straightforward extension of the pinecone python client -title: "[Feature] <title>" -labels: ["enhancement", "triage"] -body: - - type: markdown - attributes: - value: | - Thanks for taking the time to fill out this feature request! - - type: checkboxes - attributes: - label: Is this your first time submitting a feature request? - description: > - We want to make sure that features are distinct and discoverable, - so that other members of the community can find them and offer their thoughts. - - Issues are the right place to request straightforward extensions of existing functionality. - options: - - label: I have searched the existing issues, and I could not find an existing issue for this feature - required: true - - label: I am requesting a straightforward extension of existing client functionality - - type: textarea - attributes: - label: Describe the feature - description: A clear and concise description of what you want to happen. - validations: - required: true - - type: textarea - attributes: - label: Describe alternatives you've considered - description: | - A clear and concise description of any alternative solutions or features you've considered. - validations: - required: false - - type: textarea - attributes: - label: Who will this benefit? - description: | - What kind of use case will this feature be useful for? Please be specific and provide examples, this will help us prioritize properly. - validations: - required: false - - type: input - attributes: - label: Are you interested in contributing this feature? - description: Let us know if you want to write some code, and how we can help. - validations: - required: false - - type: textarea - attributes: - label: Anything else? - description: | - Links? References? Anything that will give us more context about the feature you are suggesting! - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..693231fb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "[Feature Request]" +labels: 'enhancement' +assignees: '' + +--- + +**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. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/workflows/add-labels.yaml b/.github/workflows/add-labels.yaml new file mode 100644 index 00000000..24860781 --- /dev/null +++ b/.github/workflows/add-labels.yaml @@ -0,0 +1,18 @@ +name: Label issues +on: + issues: + types: + - reopened + - opened +jobs: + label_issues: + runs-on: ubuntu-latest + permissions: + issues: write + steps: + - run: gh issue edit "$NUMBER" --add-label "$LABELS" + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GH_REPO: ${{ github.repository }} + NUMBER: ${{ github.event.issue.number }} + LABELS: status:needs-triage