feat: init the repo

2026-03-23 23:34:28 +05:30
commit 7a5a220dfe
344 changed files with 75728 additions and 0 deletions
@@ -0,0 +1,39 @@
+---
+name: Bug report
+about: Report a bug or unexpected behaviour
+title: "[Bug] "
+labels: bug
+assignees: ''
+---
+
+## Description
+
+A clear and concise description of the bug.
+
+## Steps to Reproduce
+
+```python
+import numpy as np
+from ferro_ta import ...
+
+# minimal reproducible example
+```
+
+## Expected Behaviour
+
+What you expected to happen.
+
+## Actual Behaviour
+
+What actually happens. Include the full traceback if applicable.
+
+## Environment
+
+- ferro_ta version: <!-- e.g. 0.1.0 -->
+- Python version: <!-- e.g. 3.11 -->
+- OS: <!-- e.g. Ubuntu 22.04, macOS 14, Windows 11 -->
+- TA-Lib version (if comparing): <!-- optional -->
+
+## Additional Context
+
+Any other context, screenshots, or related issues.
@@ -0,0 +1,27 @@
+---
+name: Feature request
+about: Suggest a new indicator, API improvement, or other enhancement
+title: "[Feature] "
+labels: enhancement
+assignees: ''
+---
+
+## Summary
+
+A concise description of the feature you are requesting.
+
+## Motivation
+
+Why is this feature useful? What use-case does it address?
+
+## Proposed Solution
+
+Describe the API or implementation approach you have in mind (optional).
+
+## Alternatives Considered
+
+Any alternative approaches or workarounds you have considered.
+
+## Additional Context
+
+Links to reference implementations, papers, or related issues.
@@ -0,0 +1,70 @@
+---
+name: Indicator request
+about: Request a new technical analysis indicator or a variant of an existing one
+title: "[Indicator] "
+labels: new-indicator
+assignees: ''
+---
+
+## Indicator Name
+
+<!-- The standard name, e.g. "Chande Momentum Oscillator (CMO)" or "Kaufman Adaptive MA (KAMA) variant" -->
+
+## Category
+
+<!-- Which category does this indicator belong to? -->
+- [ ] Overlap Studies (moving averages, bands)
+- [ ] Momentum Indicators
+- [ ] Volatility Indicators
+- [ ] Volume Indicators
+- [ ] Price Transform
+- [ ] Statistic Functions
+- [ ] Cycle Indicators
+- [ ] Extended / Multi-output Indicators
+- [ ] Other: ___
+
+## Reference / Formula
+
+<!-- Link to the authoritative reference (book, paper, website) and/or the mathematical formula. -->
+
+**Formula:**
+```
+# e.g.
+# CMO = 100 × (SumUp − SumDown) / (SumUp + SumDown)
+```
+
+**Reference:** <!-- URL or book citation -->
+
+## TA-Lib equivalent
+
+<!-- If this indicator exists in TA-Lib, what is the function name? -->
+- [ ] This indicator is in TA-Lib as: `TALIB_FUNCTION_NAME`
+- [ ] This indicator is NOT in TA-Lib (extension indicator)
+
+## Expected API
+
+<!-- How should the function look in ferro_ta? -->
+```python
+from ferro_ta import MY_INDICATOR
+import numpy as np
+
+close = np.array([...])
+result = MY_INDICATOR(close, timeperiod=14)
+# result: np.ndarray of float64, same length as close
+```
+
+## Use Case
+
+<!-- Why do you need this indicator? What trading strategy or analysis does it support? -->
+
+## Priority / Urgency
+
+- [ ] Nice to have
+- [ ] Would significantly improve my workflow
+- [ ] Blocking me from using ferro_ta
+
+## Willingness to Contribute
+
+- [ ] I'd like to implement this myself (see `CONTRIBUTING.md`)
+- [ ] I can help test / validate the implementation
+- [ ] I just want to request it — up to the maintainers