Skip to content

Commit 8f6fd80

Browse files
committed
Add CODEOWNERS, branch protection, and updated contributor guide with dev branch flow
1 parent 2ab82d9 commit 8f6fd80

2 files changed

Lines changed: 46 additions & 24 deletions

File tree

.github/CODEOWNERS

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# All changes must be reviewed by the project author
2+
* @vignesh2027

CONTRIBUTING.md

Lines changed: 44 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,71 @@
11
# Contributing to VORTEXRAG
22

3-
Thank you for your interest in contributing! Every improvement helps make RAG systems more faithful.
3+
Thanks for wanting to contribute! Here's everything you need to know.
44

5-
## Ways to contribute
5+
## Branch structure
66

7-
- **Bug reports** — open an issue with the bug report template
8-
- **Feature requests** — open an issue with the feature request template
9-
- **Code contributions** — fork the repo, make changes, open a PR
10-
- **Documentation** — improve README, examples, or docstrings
11-
- **Benchmarks** — run VORTEXRAG on new datasets and share results
7+
```
8+
main ← stable, protected — only reviewed PRs merge here
9+
dev ← integration branch — your PR targets this
10+
feat/* ← feature branches (e.g. feat/beir-benchmark)
11+
fix/* ← bug fix branches (e.g. fix/sdc-threshold)
12+
```
13+
14+
**Always open your PR against `dev`, not `main`.** Once reviewed and merged into `dev`, it gets merged into `main` from there.
15+
16+
If you're working on an open issue:
17+
1. Fork the repo
18+
2. Create a branch: `git checkout -b feat/your-feature`
19+
3. Make your changes + add tests
20+
4. Open a PR targeting the `dev` branch
21+
5. Comment on the issue so it gets assigned to you
1222

1323
## Getting started
1424

1525
```bash
1626
git clone https://github.com/vignesh2027/VORTEXRAG
1727
cd VORTEXRAG
1828
pip install -r requirements.txt
19-
python3 -m pytest tests/ -q # all 229 should pass
29+
python3 -m pytest tests/ -q # 247 tests should pass
2030
```
2131

2232
## Before submitting a PR
2333

24-
1. **Tests must pass**: `python3 -m pytest tests/ -q`
25-
2. **Lint must be clean**: `ruff check core/ vortexrag.py --select=E,F --ignore=E501,F401`
26-
3. **Add tests** for any new behaviour
27-
4. **Keep the math correct** — any change to a layer formula must match the paper (DOI: 10.5281/zenodo.20579702)
34+
1. Tests must pass: `python3 -m pytest tests/ -q`
35+
2. Lint must be clean: `ruff check core/ vortexrag.py --select=E,F --ignore=E501,F401`
36+
3. Add tests for any new behaviour
37+
4. If you change a layer formula, it must match the paper (DOI: [10.5281/zenodo.20579702](https://doi.org/10.5281/zenodo.20579702))
2838

2939
## Project structure
3040

3141
```
3242
core/
33-
tve.py # Layer 1 — Tri-Vector Encoding
34-
vrc.py # Layer 2 — Vortex Retrieval Cone
35-
sdc.py # Layer 3 — Semantic Drift Corrector
36-
cpg.py # Layer 4 — Context Poison Guard
37-
rfg.py # Layer 5 — Rank Fusion Gate
38-
ccb.py # Layer 6 — Causal Context Builder
39-
fv.py # Layer 7 — Faithfulness Verifier
40-
vortexrag.py # Top-level pipeline
41-
tests/ # 229 unit + integration tests
42-
paper/ # LaTeX source + compiled PDF
43+
tve.py # Layer 1 — Tri-Vector Encoding
44+
vrc.py # Layer 2 — Vortex Retrieval Cone
45+
sdc.py # Layer 3 — Semantic Drift Corrector
46+
cpg.py # Layer 4 — Context Poison Guard
47+
rfg.py # Layer 5 — Rank Fusion Gate
48+
ccb.py # Layer 6 — Causal Context Builder
49+
fv.py # Layer 7 — Faithfulness Verifier
50+
vortexrag.py # Top-level pipeline
51+
integrations/ # LangChain, LlamaIndex wrappers
52+
benchmarks/ # BEIR and other eval scripts
53+
tests/ # 247 unit + integration tests
54+
paper/ # LaTeX source + PDF
4355
```
4456

57+
## Open issues for new contributors
58+
59+
| Issue | Branch to target | Difficulty |
60+
|-------|-----------------|-----------|
61+
| [BEIR benchmark script](https://github.com/vignesh2027/VORTEXRAG/issues/3) | `feat/beir-benchmark` | Good first issue |
62+
| [LangChain integration](https://github.com/vignesh2027/VORTEXRAG/issues/4) | `feat/langchain-integration` | Good first issue |
63+
| [Biomedical domain preset](https://github.com/vignesh2027/VORTEXRAG/issues/5) | `dev` | Easy |
64+
4565
## Recognition
4666

47-
All contributors are listed in the GitHub contributors graph. Significant contributions will be acknowledged in the project README.
67+
Every merged contributor shows up in the [GitHub contributors graph](https://github.com/vignesh2027/VORTEXRAG/graphs/contributors).
4868

4969
## Questions?
5070

51-
Open a [Question issue](https://github.com/vignesh2027/VORTEXRAG/issues/new?template=question.md) — happy to help.
71+
Open a [Question issue](https://github.com/vignesh2027/VORTEXRAG/issues/new?template=question.md).

0 commit comments

Comments
 (0)