1.7 KiB
1.7 KiB
| name | about | title | labels | assignees | ||
|---|---|---|---|---|---|---|
| Good First Issue | Create an issue perfect for new contributors | [GOOD FIRST ISSUE] |
|
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
- Fork the repository
- Clone your fork:
git clone https://github.com/YOUR_USERNAME/cognee.git - Install dependencies:
uv sync --all-extrasorpip install -e . - Create a branch:
git checkout -b fix/issue-description
Testing
How to test the changes:
# 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
- Code of Conduct
- Relevant documentation links
Need Help?
- Join our Discord community
- 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.