|
1 | | -# Contributing |
| 1 | +# Contributing to Fares Rafat's AI Systems |
2 | 2 |
|
3 | | -1. Fork and branch from `main`. |
4 | | -2. `pip install -e ".[dev]"` |
5 | | -3. Add tests for new experts or pipeline layers. |
6 | | -4. `pytest -q` |
7 | | -5. Open a PR with a clear ARSENAL-layer note (L0–L6) if you change routing or memory. |
| 3 | +First off, thank you for considering contributing! We are building advanced, cost-aware LLM agent systems and intelligence aggregators. Contributions from the community ensure these architectures remain robust, open, and at the bleeding edge. |
8 | 4 |
|
9 | | -## Design rule |
| 5 | +## 🧠 What we are looking for: |
| 6 | +- **Bug Fixes:** Fixing broken flows, outdated API calls, or dependency issues. |
| 7 | +- **New LEGO Pieces (AI Earth):** Adding new logical flows from recent SOTA AI papers. |
| 8 | +- **Pipeline Optimizations (ARSENAL):** Enhancing prompt performance, reducing token cost, or refining the multi-agent orchestration. |
| 9 | +- **Documentation:** Translating concepts, fixing typos, or improving the Mermaid graphs. |
10 | 10 |
|
11 | | -Prefer **explicit claims + limits** over flashy ungrounded generation. This project is an epistemic scaffold. |
| 11 | +## 🚀 How to Contribute |
| 12 | + |
| 13 | +### 1. Fork and Clone |
| 14 | +Fork the repository to your own GitHub account and then clone it locally. |
| 15 | +```bash |
| 16 | +git clone https://github.com/YOUR-USERNAME/REPOSITORY-NAME.git |
| 17 | +cd REPOSITORY-NAME |
| 18 | +``` |
| 19 | + |
| 20 | +### 2. Branching Strategy |
| 21 | +Create a new branch for your feature or bugfix. Please use descriptive names: |
| 22 | +- `feature/new-agent-logic` |
| 23 | +- `fix/router-latency` |
| 24 | +- `docs/arabic-translation` |
| 25 | + |
| 26 | +```bash |
| 27 | +git checkout -b feature/your-feature-name |
| 28 | +``` |
| 29 | + |
| 30 | +### 3. Making Changes |
| 31 | +- Write clear, concise, and documented code. |
| 32 | +- If you are adding a new AI logic extraction, ensure you cite the original paper. |
| 33 | +- Follow the existing coding style (Python PEP-8, TypeScript standard). |
| 34 | + |
| 35 | +### 4. Testing |
| 36 | +If the repository contains tests (e.g., `pytest`), make sure to run them locally before pushing. |
| 37 | +```bash |
| 38 | +pytest tests/ |
| 39 | +``` |
| 40 | + |
| 41 | +### 5. Push and Pull Request |
| 42 | +Push your branch to your fork and submit a Pull Request against the `main` branch of this repository. |
| 43 | +```bash |
| 44 | +git push origin feature/your-feature-name |
| 45 | +``` |
| 46 | +In your PR description, explain **what** you changed and **why**. If it fixes an open issue, link to it (e.g., "Fixes #12"). |
| 47 | + |
| 48 | +## ⚖️ Code of Conduct |
| 49 | +By participating, you are expected to uphold our [Code of Conduct](CODE_OF_CONDUCT.md). We are committed to a harassment-free experience for everyone. |
| 50 | + |
| 51 | +*Built with care — from Cairo to the open web.* |
0 commit comments