Skip to content

Commit b899cf6

Browse files
echobtechobt
committed
Initial commit
0 parents  commit b899cf6

5 files changed

Lines changed: 200 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug to help us improve Cortex
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Description
10+
A clear and concise description of what the bug is.
11+
12+
## Error Message
13+
```
14+
Paste the full error message here
15+
```
16+
17+
## Screenshots
18+
If applicable, add screenshots to help explain your problem.
19+
20+
## Environment
21+
- **OS**: [e.g., Windows 11, macOS 14.0, Ubuntu 22.04]
22+
- **Cortex version**: [e.g., 1.0.0]
23+
- **Python version**: [e.g., 3.11.0]
24+
25+
## Steps to Reproduce
26+
1.
27+
2.
28+
3.
29+
30+
## Expected Behavior
31+
What you expected to happen.
32+
33+
## Actual Behavior
34+
What actually happened.
35+
36+
## Additional Context
37+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature for Cortex
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Description
10+
A clear and concise description of the feature you'd like.
11+
12+
## Use Case
13+
Describe the problem this feature would solve or the use case it addresses.
14+
15+
## Proposed Solution
16+
Describe how you'd like this feature to work.
17+
18+
## Alternatives Considered
19+
Any alternative solutions or features you've considered.
20+
21+
## Additional Context
22+
Add any other context, mockups, or screenshots about the feature request here.

‎README.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<h1 align="center">Cortex</h1>
2+
3+
The Agent-Native Development CLI. Our agent is continuously fine-tuned through community-driven incentives, enabling contributors to collaborate and compete to produce the best possible AI agent.
4+
5+
---
6+
7+
<p align="center">
8+
<img src="./assets/banner.jpg" alt="Cortex Banner" width="100%">
9+
</p>
10+
11+
<p align="center">
12+
Works on CLI. Web coming soon.
13+
</p>
14+
15+
<p align="center">
16+
<a href="https://github.com/CortexLM/cortex" target="_blank">GitHub</a> •
17+
<a href="https://discord.gg/cortexfoundation" target="_blank">Discord</a> •
18+
<a href="https://twitter.com/CortexLM" target="_blank">Twitter</a> •
19+
<a href="./docs/CONTRIBUTING.md" target="_blank">Contributing</a>
20+
</p>
21+
22+
## Installation
23+
24+
```bash
25+
curl -fsSL https://cortex.foundation/cli | sh
26+
```
27+
28+
```bash
29+
wget -qO- https://cortex.foundation/cli | sh
30+
```
31+
32+
## Supported Platforms
33+
34+
| Platform | Architecture |
35+
|----------|--------------|
36+
| macOS | Apple Silicon (arm64) |
37+
| macOS | Intel (x86_64) |
38+
| Linux | x86_64 |
39+
| Linux | arm64 |
40+
| Windows | x86_64 |
41+
| Windows | arm64 |
42+
43+
## Contributing
44+
45+
We welcome contributions from the community! See our [Contributing Guide](./docs/CONTRIBUTING.md) for details on how to contribute and how to create an issue.
46+
47+
## License
48+
49+
Copyright © 2025 Cortex Foundation. All rights reserved.

‎assets/banner.jpg‎

66.9 KB
Loading

‎docs/CONTRIBUTING.md‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# Contributing to Cortex
2+
3+
Thank you for your interest in contributing to Cortex!
4+
5+
## How to Create an Issue
6+
7+
When creating an issue, please provide as much information as possible to help us understand and resolve the problem quickly.
8+
9+
### Required Information
10+
11+
1. **Error Messages** - Copy and paste the complete error message. Include the full stack trace if available.
12+
13+
2. **Screenshots** - Visual evidence helps us understand the problem faster. Include screenshots of:
14+
- The error or unexpected behavior
15+
- Your terminal output
16+
- Any relevant UI elements
17+
18+
3. **Problem Description** - Explain clearly:
19+
- What you were trying to do
20+
- What you expected to happen
21+
- What actually happened
22+
23+
4. **Platform Information** - Tell us about your environment:
24+
- Operating System (Windows, macOS, Linux) and version
25+
- Cortex version
26+
- Python version (if applicable)
27+
- Any other relevant software versions
28+
29+
5. **Steps to Reproduce** - List the exact steps to reproduce the issue:
30+
1. Step one
31+
2. Step two
32+
3. ...
33+
34+
### Issue Template
35+
36+
```
37+
## Description
38+
[Clear description of the problem]
39+
40+
## Error Message
41+
```
42+
[Paste full error message here]
43+
```
44+
45+
## Screenshots
46+
[Attach screenshots if applicable]
47+
48+
## Environment
49+
- OS:
50+
- Cortex version:
51+
- Python version:
52+
53+
## Steps to Reproduce
54+
1.
55+
2.
56+
3.
57+
58+
## Expected Behavior
59+
[What should happen]
60+
61+
## Actual Behavior
62+
[What actually happens]
63+
```
64+
65+
## How to Contribute
66+
67+
### Code Contributions
68+
69+
1. Fork the repository
70+
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
71+
3. Make your changes
72+
4. Commit with clear messages (`git commit -m 'Add amazing feature'`)
73+
5. Push to your fork (`git push origin feature/amazing-feature`)
74+
6. Open a Pull Request
75+
76+
### PR Title Convention
77+
78+
- `feat:` New feature
79+
- `fix:` Bug fix
80+
- `docs:` Documentation changes
81+
- `refactor:` Code refactoring
82+
- `test:` Test additions or fixes
83+
- `chore:` Maintenance tasks
84+
85+
## Questions?
86+
87+
- Join our [Discord](https://discord.gg/cortexfoundation)
88+
- Open a [Discussion](https://github.com/CortexLM/cortex/discussions)
89+
90+
---
91+
92+
Thank you for contributing to Cortex!

0 commit comments

Comments
 (0)