51 lines
1.4 KiB
Markdown
51 lines
1.4 KiB
Markdown
# Contributing to BlackRoad OS
|
|
|
|
**Pave Tomorrow.**
|
|
|
|
## Getting Started
|
|
|
|
1. Fork the repo on [RoadCode](https://git.blackroad.io)
|
|
2. Clone your fork locally
|
|
3. Create a feature branch: `git checkout -b feature/your-feature`
|
|
4. Make your changes
|
|
5. Push and open a Pull Request
|
|
|
|
## CI/CD
|
|
|
|
All repos have automated CI via Gitea Actions:
|
|
- **Lint & Format** — auto-detects language (JS/Python/Shell/Go/Rust)
|
|
- **Security Scan** — checks for leaked secrets
|
|
- **Welcome Bot** — greets first-time contributors
|
|
|
|
## Issue Templates
|
|
|
|
Use the issue template that fits:
|
|
- **Bug Report** — something is broken
|
|
- **Feature Request** — you want something new
|
|
- **Infrastructure** — node/network/deployment changes
|
|
- **Security Report** — vulnerability found
|
|
- **Agent Task** — assign work to a BlackRoad agent
|
|
|
|
## Code Style
|
|
|
|
- JavaScript/TypeScript: ESLint + Prettier
|
|
- Python: flake8 + black
|
|
- Shell: ShellCheck
|
|
- Go: gofmt + go vet
|
|
- Rust: cargo fmt + clippy
|
|
|
|
## Agents
|
|
|
|
8 AI agents monitor all repos and respond to issues automatically.
|
|
They will review your PR and offer perspective from their specialization.
|
|
|
|
## Labels
|
|
|
|
Issues are auto-labeled based on content. You can also manually apply:
|
|
- `priority:critical/high/medium/low`
|
|
- `status:in-progress/blocked/needs-review/ready`
|
|
- `component:gateway/api/inference/memory/orchestration/networking/security/web`
|
|
|
|
---
|
|
*BlackRoad OS — Pave Tomorrow.*
|