Skip to content

Commit deea55d

Browse files
author
Mike Morgan
committed
Create comprehensive wiki documentation
1 parent 1dee326 commit deea55d

27 files changed

+5064
-31
lines changed

‎Bounties.md‎

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
# Bounty Program
2+
3+
## Overview
4+
5+
Get paid for contributing to Cortex Linux. Cash bounties on every merged PR, plus 2x bonus at funding.
6+
7+
## Current Bounties
8+
9+
Browse issues with the `bounty` label:
10+
https://github.com/cortexlinux/cortex/issues?q=is%3Aissue+is%3Aopen+label%3Abounty
11+
12+
## Payment Structure
13+
14+
### Immediate Payment
15+
- Paid within 48 hours of PR merge
16+
- Bitcoin, USDC, or PayPal
17+
- No equity required
18+
19+
### 2x Bonus
20+
- February 2025 (when seed funding closes)
21+
- Doubles all bounties earned
22+
- Example: Earn $500 now → Get $500 bonus later = $1,000 total
23+
24+
### Bounty Tiers
25+
26+
| Complexity | Bounty | Example |
27+
|------------|--------|---------|
28+
| Critical | $150-200 | Package manager, plugin system |
29+
| Important | $100-150 | Rollback, dependency resolution |
30+
| Standard | $75-100 | Config templates, verification |
31+
| Testing | $50-75 | Integration tests, validation |
32+
| Docs | $25-50 | User guides, API docs |
33+
34+
## How It Works
35+
36+
### 1. Find an Issue
37+
Browse bounty issues:
38+
https://github.com/cortexlinux/cortex/issues?q=is%3Aissue+is%3Aopen+label%3Abounty
39+
40+
### 2. Claim It
41+
Comment: "I'd like to work on this"
42+
Wait for assignment
43+
44+
### 3. Build It
45+
- Complete implementation
46+
- Write tests (>80% coverage)
47+
- Add documentation
48+
- Submit PR
49+
50+
### 4. Get Paid
51+
- PR reviewed and merged
52+
- Provide payment details
53+
- Receive payment within 48 hours
54+
55+
## Requirements
56+
57+
### Code Quality
58+
- ✅ Complete implementation (no TODOs)
59+
- ✅ Unit tests with >80% coverage
60+
- ✅ Documentation with examples
61+
- ✅ Integrates with existing code
62+
- ✅ Follows project style
63+
64+
### Testing
65+
- All tests pass locally
66+
- CI checks pass
67+
- Manual testing done
68+
- Edge cases covered
69+
70+
### Documentation
71+
- README for the feature
72+
- Code comments for complex logic
73+
- Usage examples
74+
- API documentation (if applicable)
75+
76+
## Payment Methods
77+
78+
### Cryptocurrency (Preferred)
79+
- **Bitcoin (BTC)**
80+
- **USDC (ERC-20 or Polygon)**
81+
82+
Provide your wallet address in PR comments.
83+
84+
### Traditional
85+
- **PayPal**
86+
- **Venmo** (US only)
87+
- **Zelle** (US only)
88+
89+
Provide your payment email.
90+
91+
## Top Contributors
92+
93+
### November 2025
94+
95+
| Developer | PRs | Total Earned | Status |
96+
|-----------|-----|--------------|--------|
97+
| @aliraza556 | 2 | $300 | Processing |
98+
| @dhvll | 1 | $100 | Processing |
99+
| @chandrapratamar | 1 | $100 | Processing |
100+
| @AlexanderLuzDH | 1 | $125 | Paid |
101+
102+
*At 2x bonus: $1,250 total*
103+
104+
## Founding Team Opportunities
105+
106+
Top contributors may be invited to:
107+
- **CTO position** (15-20% equity)
108+
- **Core team** (employment post-funding)
109+
- **Advisory board**
110+
- **Early equity grants**
111+
112+
Performance matters. Show consistent quality and you'll be considered.
113+
114+
## FAQ
115+
116+
**Q: How fast do I get paid?**
117+
A: Within 48 hours of PR merge.
118+
119+
**Q: What if my PR isn't merged?**
120+
A: No payment. Only merged PRs are paid.
121+
122+
**Q: Can I work on multiple issues?**
123+
A: Yes! Claim as many as you can handle.
124+
125+
**Q: What's the 2x bonus?**
126+
A: When funding closes (Feb 2025), all bounties earned get doubled.
127+
128+
**Q: Do I need to sign anything?**
129+
A: No contracts. Payment on merge.
130+
131+
**Q: What currency?**
132+
A: USD equivalent in BTC, USDC, or PayPal.
133+
134+
**Q: Can I negotiate bounties?**
135+
A: For exceptionally complex features, yes. Ask first.
136+
137+
## Questions?
138+
139+
Ask in Discord #dev-questions or comment on the issue.
140+
141+
**Start earning:** https://github.com/cortexlinux/cortex/issues

‎Contributing.md‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
# Contributing to Cortex Linux
2+
3+
## Welcome!
4+
5+
We're building the AI-native operating system and need your help. Whether you're a Linux expert, AI engineer, or documentation writer - there's a place for you.
6+
7+
## Quick Start
8+
9+
1. **Star the repo** ⭐
10+
2. **Join Discord:** https://discord.gg/uCqHvxjU83
11+
3. **Browse issues:** https://github.com/cortexlinux/cortex/issues
12+
4. **Claim an issue** (comment "I'll work on this")
13+
5. **Submit your PR**
14+
6. **Get paid** (bounties on merge)
15+
16+
## What We Need
17+
18+
### Developers
19+
- Python developers (LLM integration, core features)
20+
- Linux systems engineers (package management, security)
21+
- DevOps engineers (deployment, CI/CD)
22+
- Frontend developers (future CLI/UI work)
23+
24+
### Non-Developers
25+
- Technical writers (documentation)
26+
- UX designers (CLI experience)
27+
- Beta testers (try features, report bugs)
28+
- Community managers (Discord, GitHub)
29+
30+
## How Bounties Work
31+
32+
### Payment Structure
33+
- **Cash on merge:** $25-200 per feature
34+
- **2x bonus at funding:** February 2025
35+
- **Payment methods:** Bitcoin, USDC, PayPal
36+
37+
### Bounty Tiers
38+
- Critical features: $150-200
39+
- Important features: $100-150
40+
- Standard features: $75-100
41+
- Testing/docs: $25-75
42+
43+
### Payment Process
44+
1. PR gets merged
45+
2. Maintainer posts payment coordination comment
46+
3. Provide payment details (crypto address or PayPal)
47+
4. Payment sent within 48 hours
48+
5. Marked as PAID in tracking
49+
50+
## PR Guidelines
51+
52+
### Required
53+
- ✅ Complete implementation (no TODOs)
54+
- ✅ Unit tests (>80% coverage)
55+
- ✅ Documentation with examples
56+
- ✅ Integration with existing code
57+
- ✅ Passes all CI checks
58+
59+
### Template
60+
```markdown
61+
## Summary
62+
Brief description of changes
63+
64+
## Testing
65+
How you tested this
66+
67+
## Screenshots (if UI)
68+
Show the feature working
69+
70+
## Checklist
71+
- [ ] Tests pass
72+
- [ ] Documentation updated
73+
- [ ] No merge conflicts
74+
```
75+
76+
## Code Style
77+
78+
- **Python:** PEP 8, black formatting
79+
- **Naming:** snake_case for functions, PascalCase for classes
80+
- **Comments:** Docstrings for public APIs
81+
- **Types:** Type hints preferred
82+
83+
## Communication
84+
85+
### Discord Channels
86+
- **#general:** General discussion
87+
- **#dev-questions:** Technical help
88+
- **#pr-reviews:** PR feedback
89+
- **#announcements:** Project updates
90+
91+
### GitHub
92+
- **Issues:** Bug reports, feature requests
93+
- **Discussions:** Long-form conversations
94+
- **PRs:** Code submissions
95+
96+
## Recognition
97+
98+
Top contributors may be invited to:
99+
- Founding team (post-funding)
100+
- Advisory board
101+
- Early access features
102+
- Conference speaking
103+
104+
## Questions?
105+
106+
Ask in Discord #dev-questions or open a GitHub Discussion.
107+
108+
**Let's build the future of Linux together! 🧠⚡**

‎Developer-Guide.md‎

Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
# Developer Guide
2+
3+
## Development Setup
4+
```bash
5+
# Clone repository
6+
git clone https://github.com/cortexlinux/cortex.git
7+
cd cortex
8+
9+
# Create virtual environment
10+
python3 -m venv venv
11+
source venv/bin/activate
12+
13+
# Install dev dependencies
14+
pip install -r requirements.txt
15+
pip install -r requirements-dev.txt
16+
17+
# Run tests
18+
pytest tests/
19+
20+
# Run with coverage
21+
pytest --cov=cortex tests/
22+
```
23+
24+
## Project Structure
25+
```
26+
cortex/
27+
├── cortex/
28+
│ ├── __init__.py
29+
│ ├── packages.py # Package manager wrapper
30+
│ ├── llm_integration.py # Claude API integration
31+
│ ├── sandbox.py # Safe command execution
32+
│ ├── hardware.py # Hardware detection
33+
│ ├── dependencies.py # Dependency resolution
34+
│ ├── verification.py # Installation verification
35+
│ ├── rollback.py # Rollback system
36+
│ ├── config_templates.py # Config generation
37+
│ ├── logging_system.py # Logging & diagnostics
38+
│ └── context_memory.py # AI memory system
39+
├── tests/
40+
│ └── test_*.py # Unit tests
41+
├── docs/
42+
│ └── *.md # Documentation
43+
└── .github/
44+
└── workflows/ # CI/CD
45+
```
46+
47+
## Architecture
48+
49+
### Core Flow
50+
```
51+
User Input (Natural Language)
52+
↓
53+
LLM Integration Layer (Claude API)
54+
↓
55+
Package Manager Wrapper (apt/yum/dnf)
56+
↓
57+
Dependency Resolver
58+
↓
59+
Sandbox Executor (Firejail)
60+
↓
61+
Installation Verifier
62+
↓
63+
Context Memory (learns patterns)
64+
```
65+
66+
### Key Components
67+
68+
**LLM Integration (`llm_integration.py`)**
69+
- Interfaces with Claude API
70+
- Parses natural language
71+
- Generates installation plans
72+
73+
**Package Manager (`packages.py`)**
74+
- Translates intent to commands
75+
- Supports apt, yum, dnf
76+
- 32+ software categories
77+
78+
**Sandbox (`sandbox.py`)**
79+
- Firejail isolation
80+
- AppArmor policies
81+
- Safe command execution
82+
83+
**Hardware Detection (`hardware.py`)**
84+
- GPU/CPU detection
85+
- Optimization recommendations
86+
- Driver compatibility
87+
88+
## Contributing
89+
90+
### Claiming Issues
91+
92+
1. Browse [open issues](https://github.com/cortexlinux/cortex/issues)
93+
2. Comment "I'd like to work on this"
94+
3. Get assigned
95+
4. Submit PR
96+
97+
### PR Requirements
98+
99+
- Tests with >80% coverage
100+
- Documentation included
101+
- Follows code style
102+
- Passes CI checks
103+
104+
### Bounty Program
105+
106+
Cash bounties on merge:
107+
- Critical features: $150-200
108+
- Standard features: $75-150
109+
- Testing/integration: $50-75
110+
- 2x bonus at funding (Feb 2025)
111+
112+
Payment: Bitcoin, USDC, or PayPal
113+
114+
See [Bounty Program](Bounties) for details.
115+
116+
## Testing
117+
```bash
118+
# Run all tests
119+
pytest
120+
121+
# Specific test file
122+
pytest tests/test_packages.py
123+
124+
# With coverage
125+
pytest --cov=cortex tests/
126+
127+
# Watch mode
128+
pytest-watch
129+
```
130+
131+
## Code Style
132+
```bash
133+
# Format code
134+
black cortex/
135+
136+
# Lint
137+
pylint cortex/
138+
139+
# Type checking
140+
mypy cortex/
141+
```
142+
143+
## Questions?
144+
145+
- Discord: https://discord.gg/uCqHvxjU83
146+
- GitHub Discussions: https://github.com/cortexlinux/cortex/discussions

0 commit comments

Comments
 (0)