Developer onboarding improvements #43
Description
Labels: enhancement, documentation, difficulty:easy, good first issue
LOC: ~500
Description
Make it easier for new contributors to set up and understand the project.
Tasks
docker-compose setup
- Create
docker-compose.ymlwith OceanBase service - Create
docker-compose.seekdb.ymlfor SeekDB alternative - Add Makefile targets:
make docker-up,make docker-down
CONTRIBUTING.md
- Create
CONTRIBUTING.mdwith:- Development setup instructions
- How to run tests locally
- Code style guidelines
- PR process
Example scripts
- Create
examples/directory - Add
examples/quickstart.py- Basic usage - Add
examples/rag_demo.py- RAG pipeline - Add
examples/hybrid_search_demo.py- Hybrid search - Add README in examples folder
Sample AI Prompts
Create docker-compose.yml for local OceanBase development. Include:
- OceanBase CE 4.3.5 service with proper memory settings
- Health check that waits for database ready
- Volume for data persistence
- Environment variables for vector memory config
Also create docker-compose.seekdb.yml as a lightweight alternative using SeekDB image.
Create CONTRIBUTING.md with sections: Prerequisites, Development Setup (clone, poetry install,
docker-compose up), Running Tests (unit, integration, comprehensive), Code Style (ruff, mypy),
Submitting PRs (branch naming, commit messages, PR template). Reference the Makefile targets.
Create examples/ directory with working Python scripts:
1. quickstart.py - basic vector store usage (add docs, search)
2. rag_demo.py - simple RAG pipeline with LangChain
3. hybrid_search_demo.py - demonstrate sparse + dense + fulltext search
Each script should work with docker-compose setup and include comments explaining each step.
Update Makefile to add targets: docker-up, docker-down, docker-logs for managing local dev environment