74 lines
No EOL
1.7 KiB
Markdown
74 lines
No EOL
1.7 KiB
Markdown
---
|
|
name: Good First Issue
|
|
about: Create an issue perfect for new contributors
|
|
title: '[GOOD FIRST ISSUE] '
|
|
labels: ['good first issue', 'help wanted']
|
|
assignees: ''
|
|
---
|
|
|
|
## Issue Description
|
|
A clear and beginner-friendly description of what needs to be done.
|
|
|
|
## Location
|
|
**File(s)**:
|
|
**Line(s)**:
|
|
**Function/Class**:
|
|
|
|
## What Needs to Be Done
|
|
Step-by-step description of the task:
|
|
1.
|
|
2.
|
|
3.
|
|
|
|
## Context/Background
|
|
Brief explanation of why this is needed and how it fits into the larger codebase.
|
|
|
|
## Expected Outcome
|
|
What should the final result look like?
|
|
|
|
## Getting Started
|
|
### Setup Instructions
|
|
1. Fork the repository
|
|
2. Clone your fork: `git clone https://github.com/YOUR_USERNAME/cognee.git`
|
|
3. Install dependencies: `uv sync --all-extras` or `pip install -e .`
|
|
4. Create a branch: `git checkout -b fix/issue-description`
|
|
|
|
### Testing
|
|
How to test the changes:
|
|
```bash
|
|
# Commands to run tests
|
|
```
|
|
|
|
### Files to Focus On
|
|
- Primary file to modify:
|
|
- Related files to review:
|
|
- Test files to update:
|
|
|
|
## Acceptance Criteria
|
|
- [ ] Criterion 1
|
|
- [ ] Criterion 2
|
|
- [ ] Tests pass
|
|
- [ ] Code follows project style guidelines
|
|
- [ ] Documentation updated (if needed)
|
|
|
|
## Resources
|
|
- [Contributing Guide](../../CONTRIBUTING.md)
|
|
- [Code of Conduct](../../CODE_OF_CONDUCT.md)
|
|
- Relevant documentation links
|
|
|
|
## Need Help?
|
|
- Join our [Discord community](https://discord.gg/bcy8xFAtfd)
|
|
- Comment on this issue with questions
|
|
- Tag @maintainer-username for guidance
|
|
|
|
## Estimated Time
|
|
⏱️ **Estimated time**: [15 minutes / 1 hour / 2-3 hours]
|
|
|
|
## Skills Needed
|
|
- [ ] Python basics
|
|
- [ ] Git/GitHub
|
|
- [ ] Testing (optional)
|
|
- [ ] Documentation (optional)
|
|
|
|
## Additional Context
|
|
Any extra information that might be helpful for new contributors. |