Open Source

Contribute to flk.

flk is open source under AGPL-3.0. We welcome contributions from anyone — whether you're building new platforms, fixing bugs, or improving documentation.

View Repository Contributing Guide
Get Involved

Ways to contribute

High Priority

Platform Development

Build new platforms using the flk SDK. Each platform is a standalone Go binary that communicates with flk over a JSON protocol.

View SDK
Quality

Bug Reporting

Found a bug? Open an issue with reproduction steps, your flk version, OS, and the relevant configuration (with sensitive values removed).

Report Bug
Community

Documentation

Improve guides, add examples, and refine the syntax reference. Clear documentation is essential for adoption.

Edit Docs
Ideas

Feature Requests

Propose new features, platform support, or DSL improvements. Include your use case and example code where possible.

Request Feature
Requirements

Developer Certificate of Origin

All contributions require a DCO sign-off. This certifies that you have the right to submit the work and agree to the project's licensing terms. Add the -s flag to your commits.

terminal
$ git commit -s -m "feat: add new feature"

Conventional Commits

feat New feature
fix Bug fix
docs Documentation
refactor Code refactoring
test Tests
chore Maintenance
Ecosystem

Repositories

flk AGPL-3.0
Core CLI
flk-plugin-sdk Apache 2.0
SDK for building platforms
flk-platform-gh Apache 2.0
GitHub platform
flk-guides MIT
Documentation and examples
runflk.dev MIT
Documentation site
Workflow

Pull Request Process

Follow these steps to submit a contribution. For significant changes, always start with an issue to discuss the approach.

01

Open an issue first for significant changes

02

Fork the repo and branch from main

03

Sign off all commits with the -s flag

04

Follow conventional commit format

05

Submit a PR referencing the issue