Merge pull request #39 from 0xPlaygrounds/docs/pr-template

docs(github): implements pull request templates

.github/ISSUE_TEMPLATE/bug_report.md → .github/ISSUE_TEMPLATE/bug-report.md

@@ -1,23 +1,35 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
+title: 'bug: <title>'
 labels: bug
 assignees: ''
 
 ---
 
-**Describe the bug**
+- [ ] I have looked for existing issues (including closed) about this
+
+## Bug Report
+<!--
 A clear and concise description of what the bug is.
+--->
 
-**To Reproduce**
+## Reproduction
+<!--
 Code snippet.
+--->
 
-**Expected behavior**
+## Expected behavior
+<!--
 A clear and concise description of what you expected to happen.
+--->
 
-**Screenshots**
+## Screenshots
+<!--
 If applicable, add screenshots to help explain your problem.
+--->
 
-**Additional context**
+## Additional context
+<!--
 Add any other context about the problem here.
+--->

.github/ISSUE_TEMPLATE/feature-or-improvement-request.md

@@ -1,8 +1,8 @@
 ---
 name: Feature or improvement request
 about: Suggest an idea for this project
-title: ''
-labels: ''
+title: 'feat: <title>'
+labels: feat
 assignees: ''
 
 ---

.github/PULL_REQUEST_TEMPLATE/new-model-provider.md

@@ -0,0 +1,37 @@
+---
+name: New model provider
+about: Suggest a new model provider to integrate
+title: 'feat: Add support for X'
+labels: feat, model
+assignees: ''
+
+---
+
+# New model provider: <Model Provider Name>
+
+## Description
+
+Please describe the model provider you are adding to the project. Include links to their website and their api documentation.
+
+Fixes # (issue)
+
+## Testing
+
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce your results.
+
+- [ ] Test A
+- [ ] Test B
+
+## Checklist:
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] I've reviewed the provider API documentation and implemented the types of response accurately
+
+## Notes
+
+Any notes you wish to include about the nature of this PR (implementation details, specific questions, etc.)

.github/PULL_REQUEST_TEMPLATE/new-vector-store.md

@@ -0,0 +1,39 @@
+---
+name: Vector store integration request
+about: Suggest a new vector store to integrate
+title: 'feat: Add support for X vector store'
+labels: data store, feat
+assignees: ''
+
+---
+
+# New vector store: <Vector Store Name>
+
+## Description
+
+Please describe the vector store you are adding to the project. Include links to their website and their api documentation.
+
+Fixes # (issue)
+
+## Testing
+
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce your results.
+
+- [ ] Test A
+- [ ] Test B
+
+## Checklist:
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] Any dependent changes have been merged and published in downstream modules
+- [ ] I've reviewed the vector store API documentation and implemented the types of response accurately
+
+## Notes
+
+Any notes you wish to include about the nature of this PR (implementation details, specific questions, etc.)

.github/PULL_REQUEST_TEMPLATE/other.md

@@ -0,0 +1,45 @@
+---
+name: General pull request
+about: Makes a change to the code base
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+# <Pull Request Title>
+
+## Description
+
+Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
+
+Fixes # (issue)
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Breaking change
+- [ ] Documentation update
+
+## Testing
+
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce your results.
+
+- [ ] Test A
+- [ ] Test B
+
+## Checklist:
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+
+## Notes
+
+Any notes you wish to include about the nature of this PR (implementation details, specific questions, etc.)