Contribute

Join the HiveGrid community

HiveGrid is built by developers, for developers. Whether you're fixing a bug, adding a feature, or improving docs, every contribution makes a difference.

Ways to Contribute

You don't need to be a developer to contribute. There are many ways to help make HiveGrid better.

Report Bugs

Found a bug? Open an issue on GitHub with steps to reproduce. The more detail, the better.

Suggest Features

Have an idea for a new feature? Create a feature request and discuss it with the community.

Contribute Code

Pick up an issue labeled 'good first issue' or work on something from the roadmap.

Improve Docs

Help us improve documentation, fix typos, or write guides for common use cases.

Help Others

Answer questions on GitHub Discussions. Share your knowledge with the community.

Spread the Word

Star us on GitHub, write about HiveGrid, or share it with your network.

Development Setup

Get your local development environment running in 5 steps.

Fork the Repository

Create your own fork of HiveGrid on GitHub.

Clone & Install

Clone your fork and run pnpm install to set up dependencies.

Start Development

Run docker-compose up and pnpm dev to start the dev environment.

Make Changes

Create a branch, make your changes, and write tests if needed.

Submit PR

Push your branch and open a pull request against main.

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

# Install dependencies
pnpm install

# Copy environment variables
cp .env.example .env

# Start infrastructure (PostgreSQL, Redis)
docker-compose -f docker-compose-local.yml up -d

# Run database migrations
cd apps/api && python manage.py migrate && cd ../..

# Start development servers
pnpm dev

Ready to contribute?

Check out the repository, read the contributing guide, and pick your first issue.