Skip to content

Commit 987154c

Browse files
authored
Updating issue templates (#148)
## Problem Making overall changes to the repo to improve our triage process. ## Solution Adding new issue templates so users can file more specific, actionable issues. Also adding auto-labeling functionality to label new issues as needs-triage when they get opened so that we can properly triage. ## Type of Change - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] This change requires a documentation update - [ ] Infrastructure change (CI configs, etc) - [x] Non-code change (docs, etc) - [ ] None of the above: (explain here) ## Test Plan Tested the auto-labeler in the Go SDK repo
1 parent f4e025f commit 987154c

File tree

5 files changed

+93
-0
lines changed

5 files changed

+93
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: "[Bug] "
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Is this a new bug?**
11+
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.
12+
13+
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/).
14+
15+
- [ ] I believe this is a new bug
16+
- [ ] I have searched the existing Github issues and Community Forum, and I could not find an existing post for this bug
17+
18+
**Describe the bug**
19+
Describe the functionality that was working before but is broken now.
20+
21+
**Error information**
22+
If you have one, please include the full stack trace here. If not, please share as much as you can about the error.
23+
24+
**Steps to reproduce the issue locally**
25+
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).
26+
27+
**Environment**
28+
* OS Version:
29+
* Java version:
30+
* Java SDK version:
31+
32+
**Additional context**
33+
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Pinecone Community Forum
4+
url: https://community.pinecone.io/
5+
about: For support, please see the community forum.
+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Documentation
3+
about: Report an issue in our docs
4+
title: "[Docs] "
5+
labels: 'documentation'
6+
assignees: ''
7+
8+
---
9+
10+
**Description**
11+
Describe the issue that you've encountered with our documentation.
12+
13+
**Suggested solution**
14+
Describe how this issue could be fixed or improved.
15+
16+
**Link to page**
17+
Add a link to the exact documentation page where the issue occurred.
+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: "[Feature Request]"
5+
labels: 'enhancement'
6+
assignees: ''
7+
8+
---
9+
10+
**What motivated you to submit this feature request?**
11+
A clear and concise description of why you are requesting this feature - e.g. "Being able to do x would allow me to..."
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

.github/workflows/add-labels.yaml

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Label issues
2+
on:
3+
issues:
4+
types:
5+
- reopened
6+
- opened
7+
jobs:
8+
label_issues:
9+
runs-on: ubuntu-latest
10+
permissions:
11+
issues: write
12+
steps:
13+
- run: gh issue edit "$NUMBER" --add-label "$LABELS"
14+
env:
15+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
16+
GH_REPO: ${{ github.repository }}
17+
NUMBER: ${{ github.event.issue.number }}
18+
LABELS: status:needs-triage

0 commit comments

Comments
 (0)