Skip to main content
Raven is open-source and we welcome contributions. Here’s how to get involved.

​
Getting the Code

git clone https://github.com/Laxcorp-Research/project-raven.git
cd project-raven
For the full build-from-source guide including native dependencies, see:

​
Making Changes

  1. Fork the repo on GitHub
  2. Create a branch for your change
  3. Make your changes and test them
  4. Submit a pull request

​
Commit guidelines

  • One feature or fix per commit
  • Use clear commit messages: feat: add X, fix: resolve Y
  • Run npm test and tsc --noEmit before pushing

​
What not to commit

  • .env files, API keys, or any credentials
  • Generated files (build artifacts, node_modules)

​
CI Checks

Every pull request automatically runs:
  • TypeScript type checking - tsc --noEmit
  • Unit and integration tests - Vitest
Both must pass before a PR can be merged.

​
Where to Start

​
License

Raven is released under the MIT License.