rebase to main

.github/ISSUE_TEMPLATE/1_bug_report.yaml

@@ -0,0 +1,87 @@
+name: Report a bug
+description: Any errors that you encounter.
+labels: ['bug']
+body:
+  - type: markdown
+    attributes:
+      value: >
+        Before you go any further. Is this really a **🐛 bug**?
+
+        If it's a question about how AdalFlow works, have a look at our [AdalFlow documentation](https://adalflow.sylph.ai/)
+        or ask a question on our [Community Discord](https://discord.gg/ezzszrRZvT).
+
+  - type: textarea
+    attributes:
+      label: Bug description
+      description: A description of the 🐛bug🐛.
+      placeholder: |
+        A clear and concise description of what the bug is.
+
+        Include steps to reproduce, the expected behaviour, and the actual behaviour.
+
+        ```
+        The error message you got, with the full traceback if available.
+        ```
+    validations:
+      required: true
+
+  - type: textarea
+    id: versions
+    attributes:
+      label: What version are you seeing the problem on?
+      description: Use `adalflow.__version__` to get the version if it's via pip or "main branch" if you're using the latest code.
+      render: python
+    validations:
+      required: false
+
+  - type: markdown
+    attributes:
+      value: '**Note: The rest of this form is optional, but filling it out may help us to provide better support.**'
+
+  - type: textarea
+    attributes:
+      label: How to reproduce the bug
+      description: >
+        Provide steps and example code here.
+        You can also paste a link to Google Colab.
+        ```python
+        # Sample code to reproduce the problem
+        ```
+      render: python
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Error messages and logs
+      description: >
+        Provide any error messages and/or logs
+      placeholder: '# Copy the complete error messages and logs'
+      value: |
+        ```
+        # Error messages and logs here please
+        ```
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Environment
+      description: |
+        Please provide details about your environment, including the following:
+        - OS (e.g., Linux, Windows, macOS)
+      value: |
+        - OS: [e.g., Linux, Windows, macOS]
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: More info
+      description: Add any other info about the issue here.
+    validations:
+      required: false
+
+  - type: markdown
+    attributes:
+      value: '**Happy engineering!**'

.github/ISSUE_TEMPLATE/2_suggest_improvement.yaml

@@ -0,0 +1,27 @@
+name: Improvement suggestion
+description: Suggest an improvement, a code refactor, or deprecation
+labels: ['[adalflow] improvement']
+body:
+  - type: textarea
+    attributes:
+      label: Outline & Motivation
+      description: A clear and concise description of the improvement suggestion
+      placeholder: |
+        Please outline the motivation for the proposal.
+        If this is related to another GitHub issue, please link it here
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Pitch
+      description: A clear and concise description of what you want to happen.
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots here.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/3_feature_request.yaml

@@ -0,0 +1,33 @@
+name: Feature request
+description: Propose a feature for this project
+labels: ["[adalflow] new feature request"]
+body:
+  - type: textarea
+    attributes:
+      label: Description & Motivation
+      description: A clear and concise description of the feature proposal
+      placeholder: |
+        Please outline the motivation for the proposal.
+        Is your feature request related to a problem? e.g., I'm always frustrated when [...].
+        If this is related to another GitHub issue, please link it here
+
+  - type: textarea
+    attributes:
+      label: Pitch
+      description: A clear and concise description of what you want to happen.
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Alternatives
+      description: A clear and concise description of any alternative solutions or features you've considered, if any.
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the feature request here.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/4_documenting.yaml

@@ -0,0 +1,16 @@
+name: Typos and doc fixes
+description: Tell us about how we can improve our documentation and Google colab/ipynb notebooks.
+labels: ["documentation"]
+body:
+  - type: textarea
+    attributes:
+      label: 📚 Documentation
+      description: A description of the 🐛bug🐛.
+      placeholder: |
+        For typos and doc fixes, please go ahead and:
+
+        - For a simlpe typo or fix, please send directly a PR (no need to create an issue)
+        - If you are not sure about the proper solution, please describe here your finding...
+
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/5_suggest_integration.yaml

@@ -0,0 +1,32 @@
+name: New integration proposal
+description: Propose a new integration for this project, either db, retriever, model_client. We highly recommend you to find a POC from the provider team to work together on this.
+labels: ['[adalflow] integration']
+body:
+  - type: textarea
+    attributes:
+      label: Description & Motivation
+      description: A clear and concise description of the integration proposal
+      placeholder: |
+        Please outline the motivation for the proposal.
+
+
+  - type: textarea
+    attributes:
+      label: Pitch
+      description: A clear and concise description of what you want to happen.
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Provider POC
+      description: If you have a POC from the provider team, please provide it here.
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the integration request here.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/6_suggest_usecases_benchmarks.yaml

@@ -0,0 +1,32 @@
+name: Suggest use cases and benchmarks
+description: Propose new use cases that AdalFlow should support or benchmarks that we should compare against
+labels: ["new use cases/benchmarks"]
+body:
+  - type: textarea
+    attributes:
+      label: Description & Motivation
+      description: A clear and concise description of the new use case or benchmark proposal
+      placeholder: |
+        Please outline the motivation for the proposal.
+
+
+  - type: textarea
+    attributes:
+      label: Pitch
+      description: A clear and concise description of what you want to happen.
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Alternatives
+      description: A clear and concise description of any alternative solutions or features you've considered, if any.
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the feature request here.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,14 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 👍 Upvote an issue
+    url: https://github.com/SylphAI-Inc/AdalFlow/issues
+    about: You should upvote an issue if it is important to you.
+  - name: 💬 Chat with us
+    url: https://discord.gg/ezzszrRZvT
+    about: Live chat with experts, engineers, and users in our Discord community.
+  - name: 📖 Read the documentation
+    url: http://adalflow.sylph.ai/
+    about: Please consult the documentation before opening any issues!
+  # - name: 🙋 Contact us about professional services
+  #   url: https://lightning.ai
+  #   about: Contact the Lightning.ai sales team for paid support.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,38 @@
+## What does this PR do?
+
+<!--
+Please include a summary of the change and which issue is fixed.
+Please also include relevant motivation and context.
+List any dependencies that are required for this change.
+
+If we didn't discuss your PR in Github issues there's a high chance it will not be merged.
+
+The following links the related issue to the PR (https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)
+-->
+
+Fixes #\<issue_number>
+
+<!-- Does your PR introduce any breaking changes? If yes, please list them. -->
+
+<details>
+  <summary><b>Before submitting</b></summary>
+
+- Was this **discussed/agreed** via a GitHub issue? (not for typos and docs)
+- [ ] Did you read the [contributor guideline](https://adalflow.sylph.ai/contributor/index.html)?
+- [ ] Did you make sure your **PR does only one thing**, instead of bundling different changes together?
+- Did you make sure to **update the documentation** with your changes? (if necessary)
+- Did you write any **new necessary tests**? (not for typos and docs)
+- [ ] Did you verify new and **existing tests pass** locally with your changes?
+- Did you list all the **breaking changes** introduced by this pull request?
+
+
+</details>
+
+
+<!--
+
+Did you have fun?
+
+Make sure you had fun coding 🙃
+
+-->

.pre-commit-config.yaml

@@ -14,13 +14,24 @@ repos:
     hooks:
       - id: black
         args: ['--line-length=88']
+        exclude: ^docs/|.*\.(json|yaml|md|txt)$
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.4.2
     hooks:
       # Run the linter.
       - id: ruff
-        args: ['--fix', '--extend-ignore=E402']
+        args: ['--fix']
+        exclude: ^docs/|.*\.(json|yaml|md|txt)$
+
+  # Add local hooks to run custom commands
+  - repo: local
+    hooks:
+      - id: run-make-format
+        name: Run Make Format
+        entry: make format
+        language: system
+        pass_filenames: false
   # - repo: https://github.com/pycqa/flake8
   #   rev: 4.0.1
   #   hooks: