Contributing

​

Development Setup

​

Prerequisites

• Python 3.12+
• Latest Go 1.24.x patch (only for Bubble Tea TUI development and release artifacts)
• Docker (running)
• uv
• Git

​

Local Development

git clone https://github.com/usestrix/strix.git
cd strix

make setup-dev

# or manually:
uv sync
uv run pre-commit install

export STRIX_LLM="openai/gpt-5.4"
export LLM_API_KEY="your-api-key"

uv run strix --target https://example.com

​

Contributing Skills

​

Creating a Skill

1. Choose the right category
2. Create a .md file with YAML frontmatter (name and description fields)
3. Include practical examples—working payloads, commands, test cases
4. Provide validation methods to confirm findings
5. Submit via PR

​

Contributing Code

​

Pull Request Process

1. Create an issue first — Describe the problem or feature
2. Fork and branch — Work from main
3. Make changes — Follow existing code style
4. Write tests — Ensure coverage for new features
5. Run checks — make check-all should pass
6. Submit PR — Link to issue and provide context

​

Code Style

• PEP 8 with 100-character line limit
• Type hints for all functions
• Docstrings for public methods
• Small, focused functions
• Meaningful variable names

​

Package Builds

make wheel

​

Reporting Issues

• Python version and OS
• Strix version (strix --version)
• LLM being used
• Full error traceback
• Steps to reproduce

​

Community