salvacybersec/strix
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
f4d522164d36bdfc8a8e8348a185bd55852d1bcc
strix/CONTRIBUTING.md
octovimmer e38f523a45 Strix LLM Documentation and Config Changes (#315) 
* feat: add to readme new keys

* feat: shoutout strix models, docs

* fix: mypy error

* fix: base api

* docs: update quickstart and models

* fixes: changes to docs

uniform api_key variable naming

* test: git commit hook

* nevermind it was nothing

* docs: Update default model to claude-sonnet-4.6 and improve Strix Router docs

- Replace gpt-5 and opus-4.6 defaults with claude-sonnet-4.6 across all docs and code
- Rewrite Strix Router (models.mdx) page with clearer structure and messaging
- Add Strix Router as recommended option in overview.mdx and quickstart prerequisites
- Update stale Claude 4.5 references to 4.6 in anthropic.mdx, openrouter.mdx, bug_report.md
- Fix install.sh links to point to models.strix.ai and correct docs URLs
- Update error message examples in main.py to use claude-sonnet-4-6

---------

Co-authored-by: 0xallam <ahmed39652003@gmail.com>
2026-02-20 01:43:18 +04: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

  1. Clone the repository

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

  2. Install development dependencies

    make setup-dev

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

  3. Configure your LLM provider

    export STRIX_LLM="anthropic/claude-sonnet-4-6"
export LLM_API_KEY="your-api-key"

  4. 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

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

🔧 Contributing Code

Pull Request Process

  1. Create an issue first - Describe the problem or feature
  2. Fork and branch - Work from the main branch
  3. Make your changes - Follow existing code style
  4. Write/update tests - Ensure coverage for new features
  5. Run quality checks - make check-all should pass
  6. 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

✨ 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!