teleo/teleo-codex
8
0
Fork 0
Code Issues 22 Pull requests Projects Releases Packages Wiki Activity Actions 74

docs: update CONTRIBUTING.md for fork-first workflow

Browse source 
External contributors fork the repo, push to their fork, and open a PR
against living-ip/teleo-codex. Removes the clone-and-push-direct path
that requires repo write access. Adds timeline expectation (~5 minutes).

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
m3taversal 2026-04-16 18:14:09 +01:00
parent 13c7dc0c0b
commit dff7b29965
1 changed files with 16 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
CONTRIBUTING.md
View file

@ -20,20 +20,30 @@ You think something in the knowledge base is wrong or missing nuance. You file a
## What you need
- Git access to this repo (GitHub or Forgejo)
- A GitHub account
- Git installed on your machine
- Claude Code (optional but recommended — it helps format claims and check for duplicates)
## How contributions work
1. You fork the repo, push changes to your fork, and open a PR on GitHub
2. A mirror syncs your PR to the internal eval pipeline (~2 minutes)
3. AI agents evaluate your contribution against quality gates (~3 minutes)
4. If approved, it auto-merges to the knowledge base
Total time from PR to merge: **~5 minutes** for well-formed contributions.
## Path 1: Submit source material
This is the simplest contribution. You provide content; the agents do the extraction.
### 1. Clone and branch
### 1. Fork and clone
```bash
git clone https://github.com/living-ip/teleo-codex.git
# Fork on GitHub first (click "Fork" at https://github.com/living-ip/teleo-codex)
git clone https://github.com/YOUR-USERNAME/teleo-codex.git
cd teleo-codex
git checkout main && git pull
git remote add upstream https://github.com/living-ip/teleo-codex.git
git checkout -b contrib/your-name/brief-description
```
@ -79,7 +89,7 @@ Source: [what this is and why it matters]"
git push -u origin contrib/your-name/brief-description
```
Then open a PR. The domain agent reads your source, extracts claims, Leo reviews, and they merge.
Then open a PR **against `living-ip/teleo-codex` main** on GitHub. The domain agent reads your source, extracts claims, Leo reviews, and they merge.
## Path 2: Propose a claim directly
@ -87,7 +97,7 @@ You have domain expertise and want to state a thesis yourself — not just drop
### 1. Clone and branch
Same as Path 1.
Same as Path 1 (fork, clone, branch).
### 2. Check for duplicates