Documentation/Contributing

Contributing Guide

RealmKit is an open source project built by the community. Whether you're fixing a typo or adding a major feature, your contributions help make RealmKit better for everyone.

Welcome Contributors!

Every contribution matters, no matter how small

All Skill Levels

From beginners to experts, there's something you can contribute

Welcoming Community

Friendly maintainers and contributors ready to help you get started

Recognition

Contributors are recognized and credited for their valuable work

Ways to Contribute

Code Contributions

Improve the RealmKit platform and CLI

What You Can Do

Fix bugs and issues
Add new features
Improve performance
Enhance CLI functionality
Write tests

Skills Needed

JavaScript/TypeScript

Node.js

React/Next.js

Difficulty

Medium to Advanced

Documentation

Help improve guides and references

What You Can Do

Fix typos and errors
Improve explanations
Add examples
Translate content
Update outdated information

Skills Needed

Writing

Markdown

Technical communication

Difficulty

Beginner to Medium

Realm Creation

Build and share quality templates

What You Can Do

Create new realm templates
Improve existing realms
Add AI context documentation
Test and validate realms
Maintain realm quality

Skills Needed

Web development

Documentation

Best practices

Difficulty

Medium

Community Support

Help other users and grow the community

What You Can Do

Answer questions in discussions
Help troubleshoot issues
Review realm submissions
Moderate community spaces
Organize events

Skills Needed

Communication

Problem solving

Patience

Difficulty

Beginner

Getting Started

First time contributing? Follow these steps

1. Choose Your Contribution

• Browse good first issue labels
• Check documentation gaps
• Look for help wanted issues
• Propose new realm templates

2. Set Up Development

• Fork the relevant repository
• Clone your fork locally
• Install dependencies
• Read the project README

3. Make Your Changes

• Create a feature branch
• Make focused, atomic commits
• Test your changes thoroughly
• Follow coding conventions

4. Submit Contribution

• Push to your fork
• Create a pull request
• Describe your changes clearly
• Respond to review feedback

Quick Setup Commands

# Fork and clone the repository
git clone https://github.com/YOUR_USERNAME/realmkit.git
cd realmkit

# Install dependencies
npm install

# Create a feature branch
git checkout -b feature/amazing-contribution

# Make your changes and commit
git add .
git commit -m "feat: add amazing contribution"

# Push and create PR
git push origin feature/amazing-contribution