Contributing

Contributing to Codex

Thank you for your interest in contributing to Codex!

How to Contribute

Reporting Bugs

1. Check if the issue already exists in Issues
2. If not, create a new issue with:
   • Clear title and description
   • Steps to reproduce
   • Expected vs actual behavior
   • Screenshots if applicable
   • Environment details (OS, Go version, etc.)

Suggesting Features

1. Check existing issues and milestones
2. Create a new issue tagged as type: feature
3. Describe the feature and its use case
4. Explain why it would be valuable

Submitting Changes

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Make your changes
4. Write or update tests
5. Update documentation
6. Commit with conventional commit format
7. Push to your fork
8. Open a Pull Request

Development Setup

See Getting Started for setup instructions.

Code Review Process

1. Maintainers will review your PR
2. Address any requested changes
3. Once approved, your PR will be merged
4. Your contribution will be attributed in the commit

Code of Conduct

• Be respectful and inclusive
• Welcome newcomers
• Focus on constructive feedback
• Help create a positive community

Labels

Issues use the following labels:

Priority

• Priority: breaking - Critical bugs
• Priority: high - Important issues
• Priority: medium - Moderate priority
• Priority: low - Nice to have

Type

• type: bug - Something isn't working
• type: feature - New functionality
• type: docs - Documentation
• type: chore - Maintenance
• type: ui/ux - User interface

Work Complexity

• work: obvious - Simple fix
• work: standard - Normal complexity
• work: complex - Requires significant effort
• work: chaotic - Very complex

Questions?

Feel free to:

• Open an issue for questions
• Check the wiki for documentation
• Review existing issues and PRs

Thank you for contributing! 🎉