Skip to content

index.md

Latest commit

 

History

History
126 lines (82 loc) · 2.94 KB

index.md

File metadata and controls

126 lines (82 loc) · 2.94 KB

Contributing to TinyBase

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

Ways to Contribute

  • :material-bug: Report Bugs

    Found a bug? Open an issue with details on how to reproduce it.

  • :material-lightbulb: Suggest Features

    Have an idea? Open an issue to discuss new features.

  • :material-code-tags: Submit Code

    Fix bugs, add features, or improve documentation.

  • :material-file-document: Improve Docs

    Help make our documentation clearer and more complete.

Getting Started

  1. Fork the repository on GitHub
  2. Clone your fork locally
  3. Set up development environment (Development Guide)
  4. Create a branch for your changes
  5. Make your changes with tests
  6. Submit a pull request

Development Guides

Quick Start

# Clone your fork
git clone https://github.com/YOUR_USERNAME/tinybase.git
cd tinybase

# Set up environment
uv venv
source .venv/bin/activate
uv pip install -e ".[dev]"

# Run tests
pytest

# Start development server
tinybase serve --reload

Code of Conduct

We are committed to providing a welcoming and inclusive experience for everyone. Please:

  • Be respectful and considerate
  • Use inclusive language
  • Accept constructive criticism gracefully
  • Focus on what's best for the community

Pull Request Process

Before Submitting

  1. Check existing issues - Your change might already be in progress
  2. Open an issue first - For significant changes, discuss before coding
  3. Update documentation - If your change affects user-facing behavior
  4. Add tests - Ensure your changes are tested
  5. Run the test suite - Make sure nothing is broken

Submitting

  1. Create a descriptive title - Summarize the change
  2. Fill out the PR template - Provide context and details
  3. Link related issues - Use "Fixes #123" or "Closes #123"
  4. Keep changes focused - One feature/fix per PR

After Submitting

  1. Respond to reviews - Address feedback promptly
  2. Keep the PR updated - Rebase if needed
  3. Be patient - Maintainers review when available

Issue Guidelines

Bug Reports

Include:

  • TinyBase version
  • Python version
  • Operating system
  • Steps to reproduce
  • Expected vs. actual behavior
  • Error messages/logs

Feature Requests

Include:

  • Problem description
  • Proposed solution
  • Alternative approaches considered
  • Use cases

License

By contributing, you agree that your contributions will be licensed under the MIT License.

Questions?

  • GitHub Discussions - For general questions
  • GitHub Issues - For bugs and features

Thank you for contributing to TinyBase! 🎉