CONTRIBUTING.md

Contributing to Cortex

Thank you for your interest in contributing to Cortex!

How to Create an Issue

When creating an issue, please provide as much information as possible to help us understand and resolve the problem quickly.

Required Information

1. Error Messages - Copy and paste the complete error message. Include the full stack trace if available.

2. Screenshots - Visual evidence helps us understand the problem faster. Include screenshots of:

   • The error or unexpected behavior
   • Your terminal output
   • Any relevant UI elements

3. Problem Description - Explain clearly:

   • What you were trying to do
   • What you expected to happen
   • What actually happened

4. Platform Information - Tell us about your environment:

   • Operating System (Windows, macOS, Linux) and version
   • Cortex version
   • Python version (if applicable)
   • Any other relevant software versions

5. Steps to Reproduce - List the exact steps to reproduce the issue:

   1. Step one
   2. Step two
   3. ...

Issue Template

## Description
[Clear description of the problem]

## Error Message

[Paste full error message here]

## Screenshots
[Attach screenshots if applicable]

## Environment
- OS: 
- Cortex version: 
- Python version: 

## Steps to Reproduce
1. 
2. 
3. 

## Expected Behavior
[What should happen]

## Actual Behavior
[What actually happens]

How to Contribute

Code Contributions

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Make your changes
4. Commit with clear messages (git commit -m 'Add amazing feature')
5. Push to your fork (git push origin feature/amazing-feature)
6. Open a Pull Request

PR Title Convention

• feat: New feature
• fix: Bug fix
• docs: Documentation changes
• refactor: Code refactoring
• test: Test additions or fixes
• chore: Maintenance tasks

Questions?

• Join our Discord
• Open a Discussion

---

Thank you for contributing to Cortex!