feat: add issue and pull request templates with compliance workflow (#689)
* bug report * feat: add pull request template for better contribution guidelines * feat: add template compliance check for issues and pull requests * drop review action
This commit is contained in:
parent
6b50f1eaab
commit
c455d174b6
2 changed files with 86 additions and 0 deletions
54
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
54
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
|
|
@ -0,0 +1,54 @@
|
||||||
|
---
|
||||||
|
name: Bug Report
|
||||||
|
about: Create a report to help us improve Graphiti
|
||||||
|
title: '[BUG] '
|
||||||
|
labels: bug
|
||||||
|
assignees: ''
|
||||||
|
---
|
||||||
|
|
||||||
|
## Bug Description
|
||||||
|
A clear and concise description of what the bug is.
|
||||||
|
|
||||||
|
## Steps to Reproduce
|
||||||
|
Provide a minimal code example that reproduces the issue:
|
||||||
|
|
||||||
|
```python
|
||||||
|
# Your code here
|
||||||
|
```
|
||||||
|
|
||||||
|
## Expected Behavior
|
||||||
|
A clear and concise description of what you expected to happen.
|
||||||
|
|
||||||
|
## Actual Behavior
|
||||||
|
A clear and concise description of what actually happened.
|
||||||
|
|
||||||
|
## Environment
|
||||||
|
- **Graphiti Version**: [e.g. 0.15.1]
|
||||||
|
- **Python Version**: [e.g. 3.11.5]
|
||||||
|
- **Operating System**: [e.g. macOS 14.0, Ubuntu 22.04]
|
||||||
|
- **Database Backend**: [e.g. Neo4j 5.26, FalkorDB 1.1.2]
|
||||||
|
- **LLM Provider & Model**: [e.g. OpenAI gpt-4.1, Anthropic claude-4-sonnet, Google gemini-2.5-flash]
|
||||||
|
|
||||||
|
## Installation Method
|
||||||
|
- [ ] pip install
|
||||||
|
- [ ] uv add
|
||||||
|
- [ ] Development installation (git clone)
|
||||||
|
|
||||||
|
## Error Messages/Traceback
|
||||||
|
```
|
||||||
|
Paste the full error message and traceback here
|
||||||
|
```
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
```python
|
||||||
|
# Relevant configuration or initialization code
|
||||||
|
```
|
||||||
|
|
||||||
|
## Additional Context
|
||||||
|
- Does this happen consistently or intermittently?
|
||||||
|
- Which component are you using? (core library, REST server, MCP server)
|
||||||
|
- Any recent changes to your environment?
|
||||||
|
- Related issues or similar problems you've encountered?
|
||||||
|
|
||||||
|
## Possible Solution
|
||||||
|
If you have ideas about what might be causing the issue or how to fix it, please share them here.
|
||||||
32
.github/pull_request_template.md
vendored
Normal file
32
.github/pull_request_template.md
vendored
Normal file
|
|
@ -0,0 +1,32 @@
|
||||||
|
## Summary
|
||||||
|
Brief description of the changes in this PR.
|
||||||
|
|
||||||
|
## Type of Change
|
||||||
|
- [ ] Bug fix
|
||||||
|
- [ ] New feature
|
||||||
|
- [ ] Performance improvement
|
||||||
|
- [ ] Documentation/Tests
|
||||||
|
|
||||||
|
## Objective
|
||||||
|
**For new features and performance improvements:** Clearly describe the objective and rationale for this change.
|
||||||
|
|
||||||
|
## Testing
|
||||||
|
- [ ] Unit tests added/updated
|
||||||
|
- [ ] Integration tests added/updated
|
||||||
|
- [ ] All existing tests pass
|
||||||
|
|
||||||
|
## Breaking Changes
|
||||||
|
- [ ] This PR contains breaking changes
|
||||||
|
|
||||||
|
If this is a breaking change, describe:
|
||||||
|
- What functionality is affected
|
||||||
|
- Migration path for existing users
|
||||||
|
|
||||||
|
## Checklist
|
||||||
|
- [ ] Code follows project style guidelines (`make lint` passes)
|
||||||
|
- [ ] Self-review completed
|
||||||
|
- [ ] Documentation updated where necessary
|
||||||
|
- [ ] No secrets or sensitive information committed
|
||||||
|
|
||||||
|
## Related Issues
|
||||||
|
Closes #[issue number]
|
||||||
Loading…
Add table
Reference in a new issue