diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..24aa831 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,40 @@ +--- +name: Bug Report +about: Report a bug or unexpected behavior +title: '[BUG] ' +labels: bug +assignees: '' +--- + +## Bug Description +A clear and concise description of what the bug is. + +## Steps to Reproduce +1. +2. +3. + +## Expected Behavior +What you expected to happen. + +## Actual Behavior +What actually happened. + +## Environment +- **OS:** [e.g., Ubuntu 22.04, macOS 14] +- **Python version:** [e.g., 3.11.5] +- **TraceFlow version:** [e.g., 0.1.0] +- **Provider:** [e.g., OpenAI, Anthropic] + +## Code Sample +```python +# Minimal code to reproduce the issue +``` + +## Error Logs +``` +Paste any relevant error messages or stack traces +``` + +## Additional Context +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..4425ed8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,29 @@ +--- +name: Feature Request +about: Suggest a new feature or enhancement +title: '[FEATURE] ' +labels: enhancement +assignees: '' +--- + +## Feature Description +A clear and concise description of what you want. + +## Problem / Motivation +What problem does this solve? Why is this needed? + +## Proposed Solution +How would you like this to work? + +## Alternatives Considered +Any alternative solutions or features you've considered. + +## Use Case +Describe a concrete use case where this feature would help. + +```python +# Example of how the feature might be used +``` + +## Additional Context +Add any other context, mockups, or references here. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..190750f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,29 @@ +--- +name: Question / Help +about: Ask a question or request help +title: '[QUESTION] ' +labels: question +assignees: '' +--- + +## Question + + + +## Context + + + +- **What are you trying to achieve?** +- **What have you tried so far?** + +## Code Sample (if applicable) + +```python +# Your code here +``` + +## Environment +- **OS:** +- **Python version:** +- **TraceFlow version:** diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..d26f452 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,47 @@ +## Description + + + +## Type of Change + +- [ ] Bug fix (non-breaking change that fixes an issue) +- [ ] New feature (non-breaking change that adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to change) +- [ ] Documentation update +- [ ] Refactoring (no functional changes) +- [ ] Test update + +## Related Issues + + + +## Changes Made + + + +- +- +- + +## Testing + + + +- [ ] Unit tests pass (`pytest tests/`) +- [ ] Lint passes (`ruff check .`) +- [ ] Format passes (`ruff format --check .`) +- [ ] Manual testing completed + +## Screenshots (if applicable) + + + +## Checklist + +- [ ] My code follows the project's style guidelines +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing unit tests pass locally with my changes diff --git a/README.md b/README.md index 929103b..830c6e0 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,10 @@ # TraceFlow Lite +[![CI](https://github.com/khalilCodeX/traceflow-lite/actions/workflows/ci.yml/badge.svg)](https://github.com/khalilCodeX/traceflow-lite/actions/workflows/ci.yml) +[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/) +[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) +[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff) + **A control plane that makes agentic systems shippable: tracing + eval gates + fallback + budgets + replay.** **A production-grade SDK for building reliable, observable AI agent workflows.**