merge main

Author: MAfarrag

.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md

@@ -1,4 +1,4 @@
-* HapiSM version:
+* statista version:
 * Python version:
 * Operating System:
 
@@ -7,9 +7,15 @@
 Describe what you were trying to get done.
 Tell us what happened, what went wrong, and what you expected to happen.
 
-### What I Did
+### Minimal Reproducible Example
+
+```python
+# Paste a minimal code snippet that reproduces the issue or demonstrates the request.
+```
+
+### What I Did / Output
 
 ```
 Paste the command(s) you ran and the output.
-If there was a crash, please include the traceback here.
+If there was a crash, please include the full traceback here.
 ```

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,38 +1,71 @@
 ---
 name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
+about: Report a reproducible problem with the statista library (distributions, EVA, sensitivity, time-series, plotting)
+title: "[Bug]: "
+labels: [bug]
 assignees: ''
-
 ---
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+## Description
+A clear and concise description of the bug. What is wrong and what did you expect instead?
+
+## Minimal Reproducible Example (MRE)
+Provide the smallest code snippet that reproduces the issue. Include imports and any necessary setup. If randomness is involved, set a fixed seed.
+
+```python
+# Please adjust to the minimal code that triggers the issue
+import numpy as np
+import pandas as pd
+from statista import distributions  # or the relevant module
+
+np.random.seed(42)  # if applicable
+
+# code here
+```
+
+### Data sample (if applicable)
+- If the bug depends on specific data, include a very small CSV/JSON snippet or describe its structure (columns, dtypes, units, missing values). If data cannot be shared, describe how to synthesize a similar dataset.
+
+```
+# Small CSV-like example or a few rows/records
+```
+
+## Steps to Reproduce
+1. ...
+2. ...
+3. ...
+
+## Expected behavior
+Describe what you expected to happen.
 
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
+## Actual behavior / Error traceback
+Paste the full error/traceback if there is one.
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+```
+<full traceback here>
+```
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+### Plots / Figures
+- If the issue is visual (e.g., plotting, distribution fit diagnostics), attach images or paste code that generates the figure.
+- Mention the Matplotlib backend if relevant (e.g., Agg, TkAgg).
 
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+## Environment
+Please complete the following information:
+- OS: [e.g., Windows 11, macOS 14, Ubuntu 24.04]
+- Python: [e.g., 3.11.7]
+- statista version: [e.g., 0.6.3]
+- Installation method: [pip, from source, editable install]
+- Key dependencies (if relevant):
+  - numpy: [e.g., 2.0.1]
+  - scipy: [e.g., 1.14.1]
+  - pandas: [e.g., 2.2.2]
+  - matplotlib: [e.g., 3.9.1]
+  - scikit-learn: [e.g., 1.5.1]
+- Locale/encoding (if data-related): [e.g., en_US.UTF-8]
 
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
+## Randomness and Determinism
+- Does the bug disappear or change with a different random seed?
+- If applicable, specify any seeds used (e.g., np.random.seed(42)).
 
-**Additional context**
-Add any other context about the problem here.
+## Additional context
+Add any other context that might help us diagnose the problem (links to docs pages, related issues, configuration, system constraints).

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Documentation
+    url: https://github.com/Serapieum-of-alex/statista
+    about: Read the documentation and examples for statista.
+  - name: Q&A / Usage questions
+    url: https://github.com/Serapieum-of-alex/statista/discussions
+    about: Ask questions or discuss how to use statista features.

.github/ISSUE_TEMPLATE/docs_improvement.md

@@ -0,0 +1,30 @@
+---
+name: Documentation improvement
+about: Report an issue or suggest an improvement to the documentation, tutorials, or examples
+title: "[Docs]: "
+labels: [documentation]
+assignees: ''
+---
+
+## Page/Section
+- URL or path: [e.g., docs/reference/distributions-class]
+- Section heading (if applicable): [e.g., "fit" method]
+
+## Current behavior / content
+Describe what is confusing, incorrect, missing, or outdated.
+
+## Expected content
+What would you expect to see instead? Provide a proposed wording or structure if possible.
+
+## Code snippet / example
+If this is about an example or API usage, include a minimal snippet that should appear in the docs or reproduces the issue.
+
+```python
+# minimal example
+```
+
+## Screenshots / images
+Attach any relevant screenshots or figures.
+
+## Additional context
+Links to related issues/PRs or external references.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,20 +1,50 @@
 ---
 name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: ''
+about: Propose a new capability or enhancement for statista (API, algorithm, performance, UX)
+title: "[Feature]: "
+labels: [enhancement]
 assignees: ''
-
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+## Problem statement
+What problem are you trying to solve? Why is it important in the context of statistics, distributions, EVA, sensitivity analysis, time-series, or plotting?
+
+## Proposed solution
+Describe the feature in detail. If this is an API addition/change, specify the interface:
+
+```python
+# Example
+import numpy as np
+from statista import distributions
+
+def new_function(x: np.ndarray, *, param: float = 1.0) -> float:
+    ...
+```
+
+- Module(s) affected: [e.g., statista.distributions]
+- New classes/functions/methods: [list]
+- Input/Output shapes and types: [describe]
+- Parameter names/defaults: [describe]
+
+## Example usage
+Provide a minimal code snippet demonstrating how the feature would be used.
+
+```python
+# sample usage
+```
+
+## Alternatives considered
+List any alternative approaches or prior art (including SciPy, scikit-learn, statsmodels, etc.). Explain trade-offs.
+
+## Backward compatibility
+- Does this change break existing APIs? If yes, describe migration path.
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+## Performance and numerical stability
+- Any expected performance impact (time/memory)?
+- Any numerical stability considerations (e.g., underflow/overflow, precision)?
 
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+## Documentation
+- What docs/tutorials/examples would need to be added/updated?
 
-**Additional context**
-Add any other context or screenshots about the feature request here.
+## Additional context
+Links to related issues, papers, or references.

.github/ISSUE_TEMPLATE/performance_issue.md

@@ -0,0 +1,42 @@
+---
+name: Performance issue
+about: Report a performance regression or a need for optimization (speed/memory)
+title: "[Perf]: "
+labels: [performance]
+assignees: ''
+---
+
+## Summary
+Describe the performance problem and why it matters.
+
+## Minimal benchmark / profiling snippet
+Provide a minimal code sample that demonstrates the performance issue.
+
+```python
+# minimal benchmark
+import time
+start = time.perf_counter()
+# your code
+print("elapsed:", time.perf_counter() - start)
+```
+
+## Data characteristics
+- Dataset size: [rows, columns, points]
+- Dtypes and ranges: [brief]
+- Sparsity / missing values: [yes/no]
+
+## Expected vs Actual
+- Expected time/memory: [e.g., ~100ms, <200MB]
+- Actual time/memory: [e.g., ~2s, ~1.2GB]
+
+## Environment
+- OS:
+- Python:
+- statista:
+- Dependencies (numpy/scipy/pandas/matplotlib/scikit-learn):
+
+## Profiling results (if available)
+Paste cProfile, line_profiler, or memory profiler output.
+
+## Additional context
+Related issues/PRs, references, or suggested optimization ideas.

.github/dependabot.yml

@@ -29,7 +29,7 @@ Check relevant points.
 # Checklist:
 
 - [ ] updated version number in pyproject.toml
-- [ ] added changes to History.rst
+- [ ] added changes to docs/change-log.md
 - [ ] updated the latest version in README file
 - [ ] 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

.github/pull_request_template.md

@@ -20,80 +20,45 @@ jobs:
       if: github.event_name == 'pull_request'
       runs-on: ubuntu-latest
       steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           fetch-depth: 0
 
-      - name: Set up Python
-        uses: actions/setup-python@v4
+      - uses: Serapieum-of-alex/github-actions/actions/mkdocs-deploy@mkdocs/v1
         with:
+          trigger: 'pull_request'
+          package-manager: 'uv'
           python-version: '3.12'
-
-      - name: Install dependencies
-        run: |
-          pip install .[docs]
-
-      - name: Deploy to GitHub Pages (Pull Request)
-        env:
-          ACTIONS_DEPLOY_TOKEN: ${{ secrets.ACTIONS_DEPLOY_TOKEN }}
-        run: |
-          git config --global user.name '${{ github.actor }}'
-          git config --global user.email '${{ github.actor }}@users.noreply.github.com'
-
-          mike deploy --push develop
+          install-groups: 'groups: docs'
+          deploy-token: ${{ secrets.ACTIONS_DEPLOY_TOKEN }}
 
   deploy-main:
     if: github.event_name == 'push' && github.ref == 'refs/heads/main'
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
       with:
         fetch-depth: 0
-
-    - name: Set up Python
-      uses: actions/setup-python@v4
+    - uses: Serapieum-of-alex/github-actions/actions/mkdocs-deploy@main
       with:
+        trigger: 'main'
+        package-manager: 'uv'
         python-version: '3.12'
-
-    - name: Install dependencies
-      run: |
-        pip install .[docs]
-
-    - name: Deploy to GitHub Pages (Main)
-      env:
-        ACTIONS_DEPLOY_TOKEN: ${{ secrets.ACTIONS_DEPLOY_TOKEN }}
-      run: |
-        git config --global user.name '${{ github.actor }}'
-        git config --global user.email '${{ github.actor }}@users.noreply.github.com'
-        mike deploy --push main
-        mike set-default --push main
+        install-groups: 'groups: docs'
+        deploy-token: ${{ secrets.ACTIONS_DEPLOY_TOKEN }}
 
   deploy-release:
     if: github.event_name == 'release'
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
       with:
         fetch-depth: 0
-    - name: Set up Python
-      uses: actions/setup-python@v4
+    - uses: Serapieum-of-alex/github-actions/actions/mkdocs-deploy@main
       with:
+        trigger: 'release'
+        package-manager: 'uv'
         python-version: '3.12'
-
-    - name: Install dependencies
-      run: |
-          pip install .[docs]
-
-    - name: Set release notes tag
-      run: |
-        export RELEASE_TAG_VERSION=${{ github.event.release.tag_name }}
-        echo "RELEASE_TAG_VERSION=${RELEASE_TAG_VERSION}" >> $GITHUB_ENV
-
-    - name: Deploy to GitHub Pages
-      env:
-        ACTIONS_DEPLOY_TOKEN: ${{ secrets.ACTIONS_DEPLOY_TOKEN }}
-      run: |
-        git config --global user.name '${{ github.actor }}'
-        git config --global user.email '${{ github.actor }}@users.noreply.github.com'
-        mike deploy --push --update-aliases ${RELEASE_TAG_VERSION} latest
-        mike set-default --push latest
+        install-groups: 'groups: docs'
+        deploy-token: ${{ secrets.ACTIONS_DEPLOY_TOKEN }}
+        mike-alias: 'latest'