For Contributors

Welcome to the Blok Contributors Guide! This section provides comprehensive information for developers who want to contribute to the Blok framework.

Overview

Blok is an open-source project, and we welcome contributions from the community. Whether you're fixing bugs, adding features, improving documentation, or creating new extensions, your contributions help make Blok better for everyone.

Getting Started

Prerequisites

Before contributing, ensure you have:

• Node.js (v18 or later)
• Git
• A GitHub account
• Basic knowledge of TypeScript

Quick Links

• Objectives & Architecture - Understand Blok's architecture and design principles
• How to Contribute - Step-by-step contribution guidelines

Core Packages

Learn about the core packages that power Blok:

• Runner - The execution engine for workflows and nodes
• Shared - Common utilities and types used across the framework

Extensions

Extend Blok's functionality:

• Creating Nodes - Build custom nodes for specific tasks
• Creating Triggers - Implement new trigger types
• Improving CLI - Enhance the command-line interface

Ways to Contribute

1. Code Contributions

• Bug fixes
• New features
• Performance improvements
• Code refactoring

2. Documentation

• Improve existing docs
• Add examples
• Fix typos
• Translate documentation

3. Community Support

• Answer questions on Discord
• Help others on GitHub Discussions
• Share your Blok projects

4. Testing & Quality

• Write tests
• Report bugs
• Review pull requests
• Improve CI/CD

Development Workflow

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Write/update tests
5. Submit a pull request
6. Respond to feedback

Code of Conduct

We are committed to providing a welcoming and inclusive environment. Please read our Code of Conduct before contributing.

Questions?

• Discord: Join our community
• GitHub Discussions: Ask questions
• Issues: Report bugs

Thank you for your interest in contributing to Blok! 🎉