mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-08-27 14:17:10 -04:00
175746cc26
This commit prepares Headroom for public open source release with comprehensive documentation, licensing, and community infrastructure. License & Legal: - Add Apache 2.0 LICENSE file - Add NOTICE file with third-party attributions - Add SECURITY.md for vulnerability reporting Community: - Add CONTRIBUTING.md with contribution guidelines - Add CODE_OF_CONDUCT.md (Contributor Covenant) - Add GitHub issue templates (bug report, feature request) - Add pull request template Documentation: - Update README.md with compelling value proposition - Add docs/getting-started.md - Add docs/proxy.md for proxy server documentation - Add docs/transforms.md for transform reference - Add docs/api.md for API reference - Add examples/README.md Package Infrastructure: - Add headroom/py.typed for PEP 561 compliance - Add headroom/cli.py for CLI entry point - Add .github/workflows/ci.yml for CI pipeline - Add .github/workflows/publish.yml for PyPI publishing - Update pyproject.toml with proper metadata New Features: - Add multi-provider support (Google, Cohere, LiteLLM, OpenAI-compatible) - Add universal tokenizer registry with multiple backends - Add model registry with pricing and context limits - Add production proxy server with caching and rate limiting Code Quality: - Fix 83 lint issues via ruff auto-fix - Fix version consistency (benchmarks 0.1.0 → 0.2.0) - Add skip decorators for optional dependency tests
44 lines
917 B
Markdown
44 lines
917 B
Markdown
---
|
|
name: Feature Request
|
|
about: Suggest a new feature for Headroom
|
|
title: '[FEATURE] '
|
|
labels: enhancement
|
|
assignees: ''
|
|
---
|
|
|
|
## Problem Statement
|
|
|
|
A clear description of the problem you're trying to solve.
|
|
Ex: "I'm always frustrated when..."
|
|
|
|
## Proposed Solution
|
|
|
|
Describe the solution you'd like. Be as specific as possible.
|
|
|
|
## Use Case
|
|
|
|
Explain your use case and why this feature would be valuable:
|
|
|
|
- What type of application are you building?
|
|
- How would this feature help you?
|
|
- How many tokens/cost would this save?
|
|
|
|
## Alternatives Considered
|
|
|
|
Describe any alternative solutions or features you've considered.
|
|
|
|
## Example API (Optional)
|
|
|
|
If you have ideas about how the API should look:
|
|
|
|
```python
|
|
# How you'd like to use this feature
|
|
from headroom import SomeNewFeature
|
|
|
|
# Example usage
|
|
```
|
|
|
|
## Additional Context
|
|
|
|
- Are you willing to contribute this feature?
|
|
- Any relevant links, papers, or prior art?
|