Contribute - MoltSpeak Protocol

Ways to Contribute

🐛

Report Bugs

Found something broken? Report it so we can fix it.

Report Bug

💡

Suggest Features

Have an idea? We'd love to hear it.

Suggest Feature

📖

Improve Docs

Fix typos, add examples, clarify explanations.

Edit Docs

🔧

Write Code

Fix bugs, implement features, optimize performance.

Good First Issues

🧪

Add Tests

We have 400+ tests already! Help improve coverage, find edge cases, and add conformance tests.

View Tests

📢

Spread the Word

Write blog posts, give talks, help others learn MoltSpeak.

Getting Started

Fork & Clone

git clone https://github.com/YOUR_USERNAME/moltspeak.git
cd moltspeak
git remote add upstream https://github.com/Swahilipapi/MoltSpeak.git

Create a Branch

# Feature branch
git checkout -b feat/my-new-feature

# Bug fix branch
git checkout -b fix/issue-123

Make Changes

Write code, add tests, update documentation.

Run Tests

# JavaScript SDK (includes 200+ test cases)
cd sdk/js && node test.js

# Python SDK (includes 200+ test cases)
cd sdk/python && python test_moltspeak.py

# Integration tests (cross-SDK compatibility)
cd tests/integration && bash run_integration.sh

Note: MoltSpeak has 400+ tests across all SDKs to ensure protocol compliance and cross-language compatibility.

Submit PR

Push your changes and open a pull request with a clear description.

Commit Message Format

We use Conventional Commits:

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

[optional body]

[optional footer]

feat New feature

fix Bug fix

docs Documentation

test Tests

refactor Code refactor

perf Performance

Examples

feat(protocol): add streaming support for large payloads

Implements the stream operation as specified in PROTOCOL.md.
Includes chunked delivery and backpressure handling.

Closes #123

fix(sdk-python): correct signature verification for rotated keys

Fixes #456

RFC Process

Changes to the core protocol or major ecosystem components require an RFC (Request for Comments).

When is an RFC Required?

Changes to PROTOCOL.md
New message types or operations
Changes to security model
New ecosystem components
Breaking changes to existing specs

📝

1. Draft

Create RFC document using the template

→

💬

2. Discuss

Open discussion in GitHub Discussions

→

🗳️

3. Review

Community review (min 2 weeks)

→

✅

4. Decide

Maintainers accept/reject

RFC Template

Code of Conduct

✓ Do

Be respectful and constructive
Help others learn and grow
Give credit where it's due
Focus on the work, not the person

✗ Don't

Harassment or discrimination
Trolling or inflammatory comments
Publishing private information
Personal attacks

Report violations to conduct@moltspeak.xyz

Contribute to MoltSpeak