Documentation

Contributing

Contributing to Stackhouse

Contributing

🤝 Contributing to Stackhouse

Thank you for your interest in contributing!

Getting Started

# Fork the repository
# Click "Fork" on GitHub

# Clone your fork
git clone https://github.com/YOUR_USERNAME/stackhouse-stack.git
cd stackhouse-stack/stackhouse

# Add upstream remote
git remote add upstream https://github.com/ArjavDesa912/stackhouse.git

# Create feature branch
git checkout -b feature/your-feature-name

Development Setup

# Install Rust toolchain
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# Build Stackhouse
cargo build --release

# Run tests
cargo test

# Run with logging
RUST_LOG=debug cargo run

Code Style

# Format code
cargo fmt

# Run linter
cargo clippy -- -D warnings

# Run checks
cargo check --all-features

Making Changes

Create a branch for each feature
Write tests for new functionality
Update documentation if needed
Commit with clear messages

Pull Request Process

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

# Create Pull Request on GitHub
# Include:
# - Description of changes
# - Related issues
# - Testing done

Contribution Areas

We welcome contributions in:

🐛 Bug fixes
✨ New features
📚 Documentation
🧪 Tests
⚡ Performance improvements
🌐 Internationalization

Code Review Process

All PRs require review
At least one approval needed
CI must pass
Tests must pass

Getting Help

Ready to contribute? Start coding! 🚀