Nfrax Docs logoNfrax Docs

Infrastructure that just works. Ship products, not boilerplate.

Frameworks

  • svc-infra
  • ai-infra
  • fin-infra
  • robo-infra

Resources

  • Getting Started
  • What's New
  • Contributing

Community

  • GitHub

© 2026 nfrax. All rights reserved.

Nfrax Docs logoNfrax Docs
Start HereWhat's New
GitHub
open source

Contributing

Thank you for your interest in contributing! All packages follow the same workflow.

Prerequisites

Python 3.11+PoetryGit

Development Setup

# Clone and install
git clone https://github.com/nfraxlab/<package>.git
cd <package>
poetry install
poetry shell

# Verify setup
pytest -q

Development Workflow

1

Create a branch

git checkout -b feat/your-feature-name
2

Make your changes

  • Add type hints to all functions
  • Write docstrings for public APIs
  • Add tests for new functionality
  • Follow existing code style
3

Run quality checks

ruff format  # Format code
ruff check   # Lint
mypy src     # Type check
pytest -q    # Tests

Or run make ci to execute all checks at once.

4

Submit a pull request

Write a clear description, reference any related issues, and ensure all checks pass.

Commit Messages

Use Conventional Commits format for automated CHANGELOG generation.

type(scope): description
featfixdocsrefactorperftestcichore
feat: add Redis cache backend
fix: handle connection timeout

Safety Requirements

Some packages have critical safety requirements. Read the CONTRIBUTING.md in each repo before contributing.

ai-infra
Controls AI/LLM systems. Bugs can cause runaway costs or security breaches.
fin-infra
Financial software. Bugs can cause real money loss.
robo-infra
Controls physical robots. Bugs can cause physical harm or property damage.

Repositories

ai-infra
AI/ML infrastructure
svc-infra
Backend infrastructure
fin-infra
Financial infrastructure
robo-infra
Robotics infrastructure

Ready to Contribute?

Find an issue labeled good first issue and start contributing!

View on GitHubWhat's New