mirror of https://github.com/usestrix/strix.git synced 2026-08-16 09:26:39 +02:00

Files

T

0xallamandAhmed Allam 9f5ceaafa3 chore: update default model to gpt-5.4 and remove Strix Router from docs

- Change default model from gpt-5 to gpt-5.4 across docs, tests, and examples
- Remove Strix Router references from docs, quickstart, overview, and README
- Delete models.mdx (Strix Router page) and its nav entry
- Simplify install script to suggest openai/ prefix directly
- Keep strix/ model routing support intact in code

2026-03-22 22:08:20 -07:00

3.0 KiB

Raw Blame History

Contributing to Strix

Thank you for your interest in contributing to Strix! This guide will help you get started with development and contributions.

🚀 Development Setup

Prerequisites

Python 3.12+
Docker (running)
Poetry (for dependency management)
Git

Local Development

Clone the repository

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

Install development dependencies

make setup-dev

# or manually:
poetry install --with=dev
poetry run pre-commit install

Configure your LLM provider

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

Run Strix in development mode

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

📚 Contributing Skills

Skills are specialized knowledge packages that enhance agent capabilities. See strix/skills/README.md for detailed guidelines.

Quick Guide

Choose the right category (/vulnerabilities, /frameworks, /technologies, etc.)
Create a .md file with your skill content
Include practical examples - Working payloads, commands, or test cases
Provide validation methods - How to confirm findings and avoid false positives
Submit via PR with clear description

🔧 Contributing Code

Pull Request Process

Create an issue first - Describe the problem or feature
Fork and branch - Work from the main branch
Make your changes - Follow existing code style
Write/update tests - Ensure coverage for new features
Run quality checks - make check-all should pass
Submit PR - Link to issue and provide context

PR Guidelines

Clear description - Explain what and why
Small, focused changes - One feature/fix per PR
Include examples - Show before/after behavior
Update documentation - If adding features
Pass all checks - Tests, linting, type checking

Code Style

Follow PEP 8 with 100-character line limit
Use type hints for all functions
Write docstrings for public methods
Keep functions focused and small
Use meaningful variable names

🐛 Reporting Issues

When reporting bugs, please include:

Python version and OS
Strix version
LLMs being used
Full error traceback
Steps to reproduce
Expected vs actual behavior

💡 Feature Requests

We welcome feature ideas! Please:

Check existing issues first
Describe the use case clearly
Explain why it would benefit users
Consider implementation approach
Be open to discussion

🤝 Community

Discord: Join our community
Issues: GitHub Issues

✨ Recognition

We value all contributions! Contributors will be:

Listed in release notes
Thanked in our Discord
Added to contributors list (coming soon)

Questions? Reach out on Discord or create an issue. We're here to help!

3.0 KiB Raw Blame History