@n2flowjs/nbase/CONTRIBUTING.md

Neural Vector Database for efficient similarity search

# Contributing to NBase

Thank you for considering contributing to NBase! Your help is appreciated.

## How to Contribute

1. **Fork the repository** and create your branch from `main`.
2. **Clone your fork** and install dependencies:
   ```bash
   git clone https://github.com/your-username/nbase.git
   cd nbase
   npm install
   ```
3. **Create a new branch** for your feature or bugfix:
   ```bash
   git checkout -b my-feature
   ```
4. **Make your changes** and add tests if applicable.
5. **Run tests** to ensure nothing is broken:
   ```bash
   npm test
   ```
6. **Commit your changes** and push your branch:
   ```bash
   git add .
   git commit -m "Describe your change"
   git push origin my-feature
   ```
7. **Open a Pull Request** on [GitHub](https://github.com/N2FlowJS/nbase/pulls).

## Guidelines

- Write clear, concise commit messages.
- Add or update documentation as needed.
- Ensure code passes linting and tests.
- Be respectful and constructive in discussions.

## Reporting Issues

If you find a bug or have a feature request, please [open an issue](https://github.com/N2FlowJS/nbase/issues) and provide as much detail as possible.

## Code of Conduct

Please be respectful and follow the [GitHub Community Guidelines](https://docs.github.com/en/site-policy/github-terms/github-community-guidelines).

Thank you for contributing!