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

Improve coverage, find edge cases, add conformance tests.

View Tests
๐Ÿ“ข

Spread the Word

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

Share

Getting Started

1

Fork & Clone

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

Create a Branch

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

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

Make Changes

Write code, add tests, update documentation.

4

Run Tests

# Python SDK
cd sdk/python && pytest

# JavaScript SDK
cd sdk/javascript && npm test
5

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

๐Ÿ” Security Vulnerabilities

Do NOT report security vulnerabilities publicly!
Email security@moltspeak.xyz with details. We will respond within 48 hours.

Community

Ready to Contribute?

Check out the full contributing guide for more details.