ZOG Open Source

Contributing Guide

Learn how to contribute to Zero One Group's open source projects

We're excited that you're interested in contributing to Zero One Group's open source projects! This guide will help you understand our contribution process.

Ways to Contribute

1. Report Issues

  • Search existing issues before creating a new one
  • Use issue templates when available
  • Provide clear reproduction steps for bugs
  • Include relevant code samples and error messages

2. Submit Pull Requests

Development Workflow

  1. Fork the repository
  2. Create a new branch from main
  3. Make your changes
  4. Write/update tests
  5. Submit a pull request

Pull Request Guidelines

  • Follow the existing code style
  • Include tests for new features
  • Update documentation as needed
  • Keep PRs focused and atomic
  • Link related issues

3. Documentation

  • Fix typos and improve clarity
  • Add examples and use cases
  • Update API documentation

Development Standards

Code Style

  • Use TypeScript for type safety
  • Follow ESLint configuration
  • Use Prettier for formatting
  • Write meaningful commit messages

Testing

  • Write unit tests for new features
  • Ensure all tests pass locally
  • Follow existing test patterns

Getting Help

Thank you for contributing to Zero One Group's open source projects!

On this page