Skip to main content

​
Contribute to Kontext21

We’re building Kontext21 as an open source project and welcome contributions from the community. Whether you’re working on the core Rust implementation, Node.js bindings, or improving documentation, your help makes Kontext21 better for everyone.

​
Where to Contribute

Core Implementation

  • Core Rust implementation
  • Performance optimizations
  • New features and integrations
  • Bug fixes and improvements

Node.js Bindings

  • Node.js SDK
  • TypeScript definitions
  • API improvements
  • Platform compatibility

Documentation

  • Documentation site
  • Guides and tutorials
  • API documentation
  • Examples and use cases

Community

  • Join our community
  • Share use cases
  • Help others
  • Suggest improvements

​
Development Setup

# Clone the core repository
git clone https://github.com/kontext21/k21.git
cd k21

# Install dependencies
cargo build

# Run tests
cargo test

# Clone the Node.js bindings
git clone https://github.com/kontext21/k21-node.git
cd k21-node

# Install dependencies
yarn install

# Build the package
yarn build

# Run tests
yarn test

# Clone the docs repository
git clone https://github.com/kontext21/docs.git
cd docs

# Install dependencies
npm install

# Start the development server
npm run dev

​
Development Guidelines

  • Follow language-specific best practices
  • Use meaningful variable and function names
  • Add comments for complex logic
  • Keep functions small and focused
  • Write unit tests for new features
  • Add integration tests for complex flows
  • Ensure all tests pass before submitting
  • Maintain good test coverage
  • Update relevant documentation
  • Add examples for new features
  • Include JSDoc comments
  • Keep documentation up to date
  • Use clear and descriptive messages
  • Follow conventional commits format
  • Reference issues when relevant
  • Keep commits focused and atomic
Let’s build the future of user context together!
⌘I