Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
35 lines (28 loc) · 1.05 KB

CONTRIBUTING.md

File metadata and controls

35 lines (28 loc) · 1.05 KB

Contributing to Mini Vector Search Playground

🎉 Thanks for taking the time to contribute!
This project is Hacktoberfest-friendly — pull requests of all sizes are welcome.

🚀 Getting Started

  1. Fork this repository and clone your fork locally.
  2. Create a new branch for your changes: 
    git checkout -b feature/my-change
  3. Install dependencies: python -m venv .venv && source .venv/bin/activate pip install -r requirements.txt
  4. Run locally: uvicorn app.main:app --reload --port 8080 Open http://localhost:8080 in your browser.

✅ Guidelines Keep pull requests small and focused. Use clear commit messages (e.g., feat: add JSON export endpoint). Update documentation (README.md) if your change affects usage. Link the issue number in your PR description (e.g., Fixes #12). Be respectful and follow the Code of Conduct

🏷 Good First Issues If you’re new, check the issue tracker for issues labeled: Good first issue hacktoberfest documentation

These are designed to be beginner-friendly and are a great way to start contributing.