Contributing to ForgingBlocks¶

Welcome! Thank you for your interest in contributing to ForgingBlocks.

Quick summary¶

This page serves as the entry point for contributors to ForgingBlocks. It provides a quick start guide and links to detailed contributing guides.

Quick start:

# 1. Fork and clone the repository
git clone https://github.com/forging-blocks-org/forging-blocks.git
cd forging-blocks

# 2. Install dependencies
poetry install

# 3. Run tests to verify setup
poetry run poe test

Guides:
- Contribution Guide — Setup, workflow, PR guidelines, dev commands
- Documentation Conventions — Writing style, structure rules, consistency
- Release Guide — For maintainers: releases, PyPI, docs deployment

Contributing Guides¶

Contribution Guide ¶

Start here for complete setup and workflow
- Development environment setup
- Code contribution process
- Pull request guidelines
- Available development commands

Documentation Conventions ¶

For documentation contributors
- Writing style and tone guidelines
- Documentation structure rules
- Consistency requirements

Release Guide ¶

For maintainers
- How to prepare releases using poe tasks
- Automated PR-based release workflow
- Publishing to PyPI and docs deployment

Contributing Philosophy¶

ForgingBlocks values:

Quality over quantity — Well-thought-out, focused contributions
Clarity over cleverness — Code and documentation should be easy to understand
Explicit over implicit — Make intentions and behaviors clear
Consistency over convenience — Follow established patterns

Need Help?¶

New to the project? Start with the Contribution Guide
Documentation questions? See Documentation Conventions
Release questions? Check the Release Guide
Still stuck? Open an issue for discussion

Ready to contribute? Check out the full contribution guide to get started!