Contributing to Brainy

Thank you for your interest in contributing to Brainy! This document provides guidelines and instructions for contributing to the project.

We welcome contributions of all kinds, including bug fixes, feature additions, documentation improvements, and more. By participating in this project, you agree to abide by our Code of Conduct.

Commit Message Guidelines

When contributing to this project, please write clear and descriptive commit messages that explain the purpose of your changes. Good commit messages help maintainers understand your contributions and make the review process smoother.

Best Practices

Keep the first line concise (ideally under 50 characters)
Use the imperative mood ("Add feature" not "Added feature")
Reference issues and pull requests where appropriate
When necessary, provide more detailed explanations in the commit body

Examples

Add vector normalization option
Fix distance calculation in HNSW search
Update API documentation
Add support for IndexedDB storage
Change API parameter order
Simplify vector comparison logic
Add tests for metadata filtering
Update build dependencies

Pull Request Process

Ensure your code follows the project's coding standards
Update the documentation if necessary
Make sure all tests pass
Use conventional commit messages in your PR
Your PR will be reviewed by maintainers and merged if approved

Development Setup

Fork and clone the repository
Install dependencies: npm install
Build the project: npm run build
Run tests: npm test

Code Style

This project uses ESLint and Prettier for code formatting and style checking. The configuration can be found in the package.json file. Please ensure your code follows these standards:

Use 2 spaces for indentation
Use single quotes for strings
No semicolons
Trailing commas are not used
Maximum line length is 80 characters

You can check your code style by running:

npx eslint src/

Branching Strategy

main - The main branch contains the latest stable release
develop - The development branch contains the latest development changes
Feature branches - Create a branch from develop for your feature or fix

When working on a new feature or fix:

Create a new branch from develop with a descriptive name (e.g., feature/add-vector-normalization or fix/distance-calculation)
Make your changes in that branch
Submit a pull request to merge your branch into develop

Issue Reporting

Before submitting a new issue, please search existing issues to avoid duplicates.

For bugs, use the bug report template
For feature requests, use the feature request template
Be as detailed as possible in your description
Include code examples, error messages, and screenshots if applicable

Thank you for contributing to Brainy!

2.9 KiB Raw Blame History