Contributing to QWED

Thank you for your interest in contributing to QWED! We are building the verification infrastructure for the AI era, and we welcome contributions from the community.

🤝 How to Contribute

1. Reporting Bugs

• Search First: Check Issues to see if the bug is already reported.
• Use the Template: Open a new issue using the Bug Report template.
• Reproduce: Provide a minimal reproduction script or steps.

2. Suggesting Features

• Discuss First: Open a Discussion to gauge interest and refine the idea.
• RFC Process: Significant changes require a Request for Comments (RFC) issue.

3. Pull Requests

• Fork & Branch: Fork the repo and create a branch like feat/new-guard or fix/logic-error.
• Tests: Add unit tests for your changes. We aim for >90% coverage.
• Linting: Ensure your code passes our linting checks (ruff/black/mypy).
• Commit Messages: Use Conventional Commits (e.g., feat: add logic guard, fix: overflow error).
• PR Template: Fill out the PR template completely.

🛠️ Development Setup

Most QWED repositories follow this setup:

# Clone the repo
git clone https://github.com/QWED-AI/qwed-verification.git
cd qwed-verification

# Create venv
python -m venv venv
source venv/bin/activate  # or venv\Scripts\activate on Windows

# Install dev dependencies
pip install -e ".[dev]"

# Run tests
pytest

📜 Code of Conduct

We are committed to providing a friendly, safe, and welcoming environment for all. Please be respectful and professional in all interactions.

📝 License

By contributing, you agree that your contributions will be licensed under the Apache 2.0 License.