Skip to content

Self-evolving Context Database for AI Agents. Unify Agent Memory, Knowledge RAG and Skills.

feat: add GitHub issue and PR templates (#8)

qin-ctx07e290a9af6b
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 000000000..434263d21
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,106 @@
+name: Bug Report
+description: Report a bug or unexpected behavior
+title: "[Bug]: "
+labels: ["bug"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thanks for taking the time to report a bug! Please fill out the form below.
+
+ - type: textarea
+ id: description
+ attributes:
+ label: Bug Description
+ description: A clear and concise description of what the bug is.
+ placeholder: Describe the bug...
+ validations:
+ required: true
+
+ - type: textarea
+ id: reproduce
+ attributes:
+ label: Steps to Reproduce
+ description: Steps to reproduce the behavior.
+ placeholder: |
+ 1. Initialize client with '...'
+ 2. Call method '...'
+ 3. See error
+ validations:
+ required: true
+
+ - type: textarea
+ id: expected
+ attributes:
+ label: Expected Behavior
+ description: What did you expect to happen?
+ validations:
+ required: true
+
+ - type: textarea
+ id: actual
+ attributes:
+ label: Actual Behavior
+ description: What actually happened?
+ validations:
+ required: true
+
+ - type: textarea
+ id: code
+ attributes:
+ label: Minimal Reproducible Example
+ description: If applicable, provide a minimal code example that reproduces the issue.
+ render: python
+
+ - type: textarea
+ id: logs
+ attributes:
+ label: Error Logs
+ description: If applicable, paste any error messages or stack traces.
+ render: shell
+
+ - type: input
+ id: version
+ attributes:
+ label: OpenViking Version
+ description: What version of OpenViking are you using?
+ placeholder: e.g., 0.1.0
+ validations:
+ required: true
+
+ - type: input
+ id: python-version
+ attributes:
+ label: Python Version
+ description: What version of Python are you using?
+ placeholder: e.g., 3.10.0
+ validations:
+ required: true
+
+ - type: dropdown
+ id: os
+ attributes:
+ label: Operating System
+ options:
+ - Linux
+ - macOS
+ - Windows
+ - Other
+ validations:
+ required: true
+
+ - type: dropdown
+ id: backend
+ attributes:
+ label: Model Backend
+ description: Which model backend are you using?
+ options:
+ - Volcengine (Doubao)
+ - OpenAI
+ - Other
+
+ - type: textarea
+ id: additional
+ attributes:
+ label: Additional Context
+ description: 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 000000000..d45835a5d
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,11 @@
+blank_issues_enabled: false
+contact_links:
+ - name: Documentation
+ url: https://www.openviking.ai/docs
+ about: Check the documentation for guides and API reference
+ - name: Discord Community
+ url: https://discord.com/invite/eHvx8E9XF3
+ about: Join our Discord server for discussions and support
+ - name: Questions & Discussions
+ url: https://github.com/volcengine/OpenViking/discussions
+ about: Ask questions and share ideas in GitHub Discussions
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
new file mode 100644
index 000000000..ca174be97
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,80 @@
+name: Feature Request
+description: Suggest a new feature or enhancement
+title: "[Feature]: "
+labels: ["enhancement"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thanks for suggesting a feature! Please fill out the form below.
+
+ - type: textarea
+ id: problem
+ attributes:
+ label: Problem Statement
+ description: Is your feature request related to a problem? Please describe.
+ placeholder: A clear description of what the problem is. Ex. I'm always frustrated when...
+ validations:
+ required: true
+
+ - type: textarea
+ id: solution
+ attributes:
+ label: Proposed Solution
+ description: Describe the solution you'd like.
+ placeholder: A clear description of what you want to happen.
+ validations:
+ required: true
+
+ - type: textarea
+ id: alternatives
+ attributes:
+ label: Alternatives Considered
+ description: Describe any alternative solutions or features you've considered.
+
+ - type: dropdown
+ id: area
+ attributes:
+ label: Feature Area
+ description: Which area of OpenViking does this feature relate to?
+ options:
+ - Core (Client/Engine)
+ - Filesystem Operations
+ - Retrieval/Search
+ - Session Management
+ - Model Integration
+ - Storage/VectorDB
+ - CLI Tools
+ - Documentation
+ - Other
+ validations:
+ required: true
+
+ - type: textarea
+ id: use-case
+ attributes:
+ label: Use Case
+ description: Describe the use case for this feature.
+ placeholder: How would you use this feature in your project?
+ validations:
+ required: true
+
+ - type: textarea
+ id: code-example
+ attributes:
+ label: Example API (Optional)
+ description: If applicable, provide an example of how the API might look.
+ render: python
+
+ - type: textarea
+ id: additional
+ attributes:
+ label: Additional Context
+ description: Add any other context, screenshots, or references about the feature request.
+
+ - type: checkboxes
+ id: contribution
+ attributes:
+ label: Contribution
+ options:
+ - label: I am willing to contribute to implementing this feature
diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml
new file mode 100644
index 000000000..4ac80418f
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/question.yml
@@ -0,0 +1,55 @@
+name: Question
+description: Ask a question about OpenViking usage
+title: "[Question]: "
+labels: ["question"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Have a question about OpenViking? We're here to help!
+
+ - type: textarea
+ id: question
+ attributes:
+ label: Your Question
+ description: What would you like to know?
+ placeholder: Describe your question clearly...
+ validations:
+ required: true
+
+ - type: textarea
+ id: context
+ attributes:
+ label: Context
+ description: Provide any relevant context or background.
+ placeholder: |
+ - What are you trying to achieve?
+ - What have you tried so far?
+
+ - type: textarea
+ id: code
+ attributes:
+ label: Code Example (Optional)
+ description: If applicable, share relevant code.
+ render: python
+
+ - type: dropdown
+ id: area
+ attributes:
+ label: Related Area
+ options:
+ - Installation / Setup
+ - Configuration
+ - API Usage
+ - Retrieval / Search
+ - Session Management
+ - Performance
+ - Other
+
+ - type: checkboxes
+ id: checked-docs
+ attributes:
+ label: Before Asking
+ options:
+ - label: I have checked the [documentation](https://www.openviking.ai/docs)
+ required: true
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 000000000..6123081c3
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,56 @@
+## Description
+
+<!-- Provide a brief description of the changes in this PR -->
+
+## Related Issue
+
+<!-- Link to the related issue (if applicable) -->
+<!-- Fixes #(issue number) -->
+
+## Type of Change
+
+<!-- Mark the relevant option with an "x" -->
+
+- [ ] Bug fix (non-breaking change that fixes an issue)
+- [ ] New feature (non-breaking change that adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation update
+- [ ] Refactoring (no functional changes)
+- [ ] Performance improvement
+- [ ] Test update
+
+## Changes Made
+
+<!-- List the main changes made in this PR -->
+
+-
+-
+-
+
+## Testing
+
+<!-- Describe how you tested your changes -->
+
+- [ ] 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 have tested this on the following platforms:
+ - [ ] Linux
+ - [ ] macOS
+ - [ ] Windows
+
+## Checklist
+
+- [ ] My code follows the project's coding style
+- [ ] I have performed a self-review of my 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
+- [ ] Any dependent changes have been merged and published
+
+## Screenshots (if applicable)
+
+<!-- Add screenshots to help explain your changes -->
+
+## Additional Notes
+
+<!-- Add any additional notes or context about the PR -->