Skip to content

Contributing

Thanks for your interest in contributing to Vecnest.

Code of conduct

Be respectful and constructive. We aim for a welcoming environment for everyone.

How to contribute

  1. Bug reports — Open an issue with steps to reproduce, environment (browser, Node version), and expected vs actual behavior.
  2. Feature ideas — Open an issue describing the use case and proposed API or behavior.
  3. Docs — Fix typos, clarify wording, or add examples via pull requests.
  4. Code — Open a PR against main. Keep changes focused; add or update tests if applicable.

Development setup

git clone <repo-url>
cd vecnest
npm install
npm run dev        # React demo at http://localhost:5174
npm run dev:js     # JS-only example at http://localhost:5175
npm run build      # Production build

Documentation (MkDocs)

The docs site is built with MkDocs and Material for MkDocs, and deployed on Read the Docs.

Setup:

pip install -r requirements-docs.txt

Serve locally:

npm run docs

Then open http://127.0.0.1:8001/.

Build static site:

npm run docs:build

Output is in site/. The live docs are at vecnest.readthedocs.io; Read the Docs builds automatically on push.

Feedback

  • GitHub Discussions — Use for questions, ideas, and feedback (when the repo has Discussions enabled).
  • Issues — Use for bugs and concrete feature requests.

We iterate based on community feedback and usage. If you build something with Vecnest, we’d love to hear about it.