[wip][documentation] Adding contributing guide in the documentation

.github/ISSUE_TEMPLATE/1_bug_report.yaml

@@ -0,0 +1,90 @@
+name: Report a bug
+description: Any errors that you encounter.
+labels: ['needs triage', '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: |
+        <details>
+          <summary>Current environment</summary>
+
+        </details>
+    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: ['needs triage', 'refactor']
+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: ["needs triage", "feature"]
+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: ["needs triage", "docs"]
+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: Feature request
+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: ['needs triage', 'feature']
+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/config.yml

@@ -0,0 +1,11 @@
+blank_issues_enabled: false
+contact_links:
+  - 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.

adalflow/.gitignore

@@ -1,3 +1,4 @@
 tests/log
 *.png
 *.svg
+CONTRIBUTING.md

adalflow/PACKAGING.md

@@ -25,5 +25,5 @@ Test the package locally:
 Better to use a colab to update the whl file and test the installation.
 
 ```bash
-pip install "dist/lightrag-0.1.0b1-py3-none-any.whl[openai,groq,faiss]"
+pip install "dist/adalflow-0.1.0b1-py3-none-any.whl[openai,groq,faiss]"
 ```

docs/source/contributor/contribute_to_code.rst

@@ -1,4 +1,4 @@
-Contribute to Code
+Coding and Testing
 ======================================
 This document will cover how you can contribute to lightRAG codebase.
 
@@ -62,18 +62,18 @@ Code Tips
 Dependencies
 ^^^^^^^^^^^^^^^^^^^
 If you want to add any new dependencies to the package, please include them in your PR description to inform us.
-Since we have already set up the testing automatic workflow in GitHub, please also set your new dependencies in 
+Since we have already set up the testing automatic workflow in GitHub, please also set your new dependencies in
 ``./lightrag/pyproject.toml`` file ``[tool.poetry.group.test.dependencies]`` section to avoid dependency errors in our CI/CD workflow.
 
-In order to correctly add the dependency using ``poetry``, please run 
+In order to correctly add the dependency using ``poetry``, please run
 
 .. code-block:: bash
 
         poetry add --group test <package-name>
 
 Testing
 ^^^^^^^^^^^^^^^^^^^
-After you update the code, please make sure your code is well tested before making a pull request. 
+After you update the code, please make sure your code is well tested before making a pull request.
 There is a ``./lightrag/tests`` folder in the project directory to host your unit testing cases.
 
 You might need to install the testing packages using ``poetry``:
@@ -92,5 +92,3 @@ All the test scripts should start with ``test_``. For example, run the individua
 .. code-block:: bash
 
     python lightrag/tests/test_components.py
-
-

docs/source/contributor/contribute_to_document.rst

@@ -1,4 +1,4 @@
-Contribute to Documentation
+Documenting
 ===============================================
 
 .. contents::
@@ -39,7 +39,7 @@ LightRAG's documentation style is `pydata_sphinx_theme <https://pydata-sphinx-th
 .. .. code-block:: bash
 
 ..     cd docs
-..     pip install -r requirements.txt 
+..     pip install -r requirements.txt
 
 Install by ``poetry`` along with all other dependencies for LightRAG:
 
@@ -59,9 +59,9 @@ Install by ``poetry`` along with all other dependencies for LightRAG:
 
 This file (``docs/source/conf.py``) contains configurations used by Sphinx, including extensions, templates, HTML theme, and language settings.
 
-**Source Code Doc-string** 
+**Source Code Doc-string**
 
-Follow `Google style docstrings <https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html>`_ to update your source code docstrings. Limit lines to **80** characters for better readability in various environments. 
+Follow `Google style docstrings <https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html>`_ to update your source code docstrings. Limit lines to **80** characters for better readability in various environments.
 
 **RST Files**: Directly edit ``.rst`` files for broader changes or new sections. Use the ``.. toctree::`` directive to link documents.
 
@@ -74,7 +74,7 @@ The Sphinx build will show warnings but the docs will still be completed.
 If you have a module folder containing code, for example, ``components/``, please add the following line to the ``docs/Makefile`` in the ``apidoc:`` section.
 
 .. code-block:: bash
-    
+
     @sphinx-apidoc -o $(APIDOCOUTDIR)/components ../components --separate --force
 
 
@@ -112,4 +112,3 @@ Commit Changes
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
 After making changes, commit the ``.rst`` and source files, avoiding the ``docs/build`` directory, and push them to your GitHub fork for review.
-