Contributing¶

Thank you for your interest in contributing to InnoClaw! This guide explains how to get involved.

Getting Started¶

Fork the repository on GitHub

Clone your fork locally:

git clone https://github.com/your-username/notebooklm.git
cd notebooklm

Install dependencies:
```
npm install
```
Follow the Installation Guide to set up your development environment

Branching Strategy¶

main — Stable production branch
Feature branches — Created from main for new features or bug fixes

Branch Naming Convention¶

feature/short-description
fix/issue-number-description
docs/what-is-changing

Commit Conventions¶

We follow Conventional Commits:

<type>(<scope>): <short description>

[optional body]

Commit Types¶

Type	Description
`feat`	A new feature
`fix`	A bug fix
`docs`	Documentation changes
`style`	Code style changes (formatting, no logic change)
`refactor`	Code refactoring (no feature or fix)
`test`	Adding or updating tests
`chore`	Build process or auxiliary tool changes

Examples¶

feat(chat): add streaming response indicator
fix(files): handle special characters in filenames
docs(api): update endpoint documentation

Pull Request Process¶

Create a branch from main with a descriptive name
Make your changes and commit with conventional commit messages
Run checks before submitting:
```
npm run lint
npm run build
npm test
```
Push your branch and open a Pull Request
Describe your changes clearly in the PR description
Wait for review — maintainers will review your code

PR Checklist¶

Code follows the project’s coding style
Tests pass (npm test)
Lint passes (npm run lint)
Build succeeds (npm run build)
Documentation updated (if applicable)

Code of Conduct¶

Please be respectful and constructive in all interactions. We aim to create a welcoming and inclusive community.

Reporting Issues¶

Use GitHub Issues to report bugs or request features
Include clear steps to reproduce any bugs
Provide environment details (OS, Node.js version, browser)