> ## Documentation Index
> Fetch the complete documentation index at: https://o1.network/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Contributing

# Contributing to O1

We welcome contributions from the community! This guide will help you get started with contributing to the O1 project.

## How to Contribute

### Reporting Issues

* Use our [GitHub Issues](https://github.com/zer0ne-io/homelab/issues) page
* Provide detailed descriptions of bugs or feature requests
* Include relevant logs, screenshots, and reproduction steps

### Code Contributions

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests if applicable
5. Submit a pull request

### Documentation Improvements

* Fix typos and improve clarity
* Add missing documentation
* Update outdated information
* Translate documentation to other languages

## Development Setup

### Prerequisites

* Node.js 16+
* Docker and Docker Compose
* Git

### Local Development

```bash theme={"theme":{"light":"github-light","dark":"one-dark-pro"}}
# Clone the repository
git clone https://github.com/zer0ne-io/homelab.git
cd homelab

# Install dependencies
npm install

# Start development environment
docker-compose up -d

# Run tests
npm test
```

## Code Standards

### Style Guide

* Use consistent indentation (2 spaces)
* Follow TypeScript/JavaScript best practices
* Write clear, descriptive variable and function names
* Add comments for complex logic

### Testing

* Write unit tests for new features
* Ensure existing tests pass
* Add integration tests for API endpoints
* Test edge cases and error conditions

### Documentation

* Update README files for significant changes
* Document new API endpoints
* Add code examples where helpful
* Keep changelogs updated

## Pull Request Process

1. **Create an Issue**: Discuss proposed changes before coding
2. **Fork and Branch**: Create a feature branch from main
3. **Make Changes**: Implement your feature or fix
4. **Test Thoroughly**: Ensure all tests pass
5. **Submit PR**: Create a pull request with clear description
6. **Review Process**: Address feedback from maintainers
7. **Merge**: Once approved, your changes will be merged

## Communication

### Discussion Channels

* GitHub Issues for technical discussions
* Discord for community chat
* Email for private matters

### Code of Conduct

We expect all contributors to follow our code of conduct:

* Be respectful and inclusive
* Focus on constructive feedback
* Help create a welcoming environment

## Recognition

Contributors are recognized in our:

* README file
* Release notes
* Community announcements

## Getting Help

If you need help getting started:

* Check existing documentation
* Ask questions in discussions
* Reach out to maintainers

We appreciate your interest in contributing to O1!
