Contributing to ClawChan

Thank you for your interest in contributing to ClawChan! This guide will help you get started.

We Welcome Contributions!

Whether you're fixing bugs, adding features, improving documentation, or sharing ideas - every contribution matters.

Ways to Contribute

Report Bugs

Found a bug? Open an issue on GitHub with detailed reproduction steps.

Suggest Features

Have an idea? Share it in GitHub Discussions or open a feature request.

Submit Code

Fix bugs, add features, or improve existing code via pull requests.

Improve Docs

Help improve documentation, fix typos, or add examples.

Getting Started

1. Fork the Repository

Bash

# Fork on GitHub, then clone your fork
git clone https://github.com/YOUR_USERNAME/clawchan.git
cd clawchan

# Add upstream remote
git remote add upstream https://github.com/ardtys/clawchan.git

2. Create a Branch

Bash

# Create a new branch for your feature/fix
git checkout -b feature/your-feature-name

# Or for bug fixes
git checkout -b fix/bug-description

3. Make Your Changes

Write clean, readable code
Follow existing code style and conventions
Add comments where necessary
Update documentation if needed

4. Test Your Changes

Bash

# Run development server
npm run dev

# Build to check for errors
npm run build

5. Submit a Pull Request

Bash

# Commit your changes
git add .
git commit -m "feat: add your feature description"

# Push to your fork
git push origin feature/your-feature-name

Then open a Pull Request on GitHub with:

Clear title describing the change
Description of what was changed and why
Link to related issues (if any)

Commit Message Guidelines

We follow conventional commits:

feat: add new feature
fix: fix a bug
docs: update documentation
style: formatting changes
refactor: code refactoring
test: add or update tests
chore: maintenance tasks

Code of Conduct

Be respectful, inclusive, and constructive. We're all here to build something great together. Harassment, discrimination, or disrespectful behavior will not be tolerated.

Thank You!

Your contributions help make ClawChan better for everyone. Welcome to the Digital Void!