search

ComposioHQ / composio

Composio equips agents with well-crafted tools empowering them to tackle complex tasks
https://docs.composio.dev
Other
1.3k stars 426 forks source link

add cn readme #249

Closed composio-dev closed 2 days ago

composio-dev commented 6 days ago

PR Type

Documentation

Description

Changes walkthrough 📝

Relevant files
Documentation
README-CN.md
Add Chinese README with comprehensive project details       
README-CN.md
  • Added a new README file in Chinese.
  • Included sections for features, quick start guides, examples, and
    contribution guidelines.
  • Provided installation instructions for Python and JavaScript.
  • Added links to social media, documentation, and contribution
    resources.
    		•  +281/-0 
    README.md
    Add language switch links to README                                           
    README.md
  • Added links to switch between English and Chinese versions of the
    README.
    		•  +4/-0     

    💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    ellipsis-dev[bot] commented 6 days ago

    Your free trial has expired. To keep using Ellipsis, sign up at https://app.ellipsis.dev for $20/seat/month or reach us at help@ellipsis.dev

    codiumai-pr-agent-pro[bot] commented 6 days ago

    PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Key issues to review

    None
    codiumai-pr-agent-pro[bot] commented 6 days ago

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Accessibility
    Add missing alt attributes to images for better accessibility and SEO ___ **To improve accessibility and SEO, consider adding alt attributes to the images where they
    are missing. This helps screen readers and search engines understand the content of the
    images.** [README-CN.md [87]](https://github.com/ComposioHQ/composio/pull/249/files#diff-3b6459f9330e366b00c2c21b99b2b154ed014c619559a4ed6d3328585d5995dbR87-R87) ```diff - +Banner illustration ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 10 Why: Adding alt attributes to images is essential for accessibility and SEO. This suggestion ensures that screen readers and search engines can understand the content of the images, making the document more inclusive and discoverable.
    		10
    Security
    Update links to use HTTPS for enhanced security ___ **Ensure that the links to external resources, such as documentation and contribution
    guidelines, use secure HTTPS protocols to enhance security and trust.** [README-CN.md [271]](https://github.com/ComposioHQ/composio/pull/249/files#diff-3b6459f9330e366b00c2c21b99b2b154ed014c619559a4ed6d3328585d5995dbR271-R271) ```diff -[文档](http://docs.composio.dev/?utm_campaign=github-readme) +[文档](https://docs.composio.dev/?utm_campaign=github-readme) ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 10 Why: Using HTTPS for external links enhances security and trust. This is a critical improvement that ensures data integrity and user safety.
    		10
    Enhancement
    ✅ Add valid URLs to the language navigation links ___
    Suggestion Impact:The commit added valid URLs to the language navigation links, ensuring users can navigate correctly between different language versions of the README. code diff: ```diff

    - EN | CN -

    + EN | CN +

    ```
    ___ **It's recommended to provide valid URLs in the hyperlinks to ensure users can navigate
    correctly between different language versions of the README. Currently, the href
    attributes are empty.** [README-CN.md [2]](https://github.com/ComposioHQ/composio/pull/249/files#diff-3b6459f9330e366b00c2c21b99b2b154ed014c619559a4ed6d3328585d5995dbR2-R2) ```diff -EN | CN +EN | CN ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 9 Why: Adding valid URLs to the language navigation links is crucial for user navigation and improves the overall user experience. This suggestion directly addresses a usability issue.
    		9
    Standardize image sizes for a cleaner layout ___ **To enhance the visual appeal and readability of the README, consider using consistent
    image sizes for logos and icons, especially when they are displayed side by side.** [README-CN.md [6-9]](https://github.com/ComposioHQ/composio/pull/249/files#diff-3b6459f9330e366b00c2c21b99b2b154ed014c619559a4ed6d3328585d5995dbR6-R9) ```diff -Composio 标志 -Composio 标志 +Composio 标志 +Composio 标志 ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 6 Why: Standardizing image sizes improves the visual appeal and readability of the README. While this is a good enhancement, it is not as critical as the other suggestions.
    		6
    codiumai-pr-agent-pro[bot] commented 5 days ago

    PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

    CI Failure Feedback 🧐

    **Action:** test (ubuntu-latest, 3.10)
    **Failed stage:** [Unittests](https://github.com/ComposioHQ/composio/actions/runs/9794582991/job/27044930227) [❌]
    **Failed test name:** test_list_all
    **Failure summary:** The action failed because the test test_list_all in the file tests/test_cli/test_connections.py
    failed.
  • The test failed due to an assertion error where the expected exit code was 0, but the actual exit
    code was 1.
  • The error message indicates that the application failed to respond, resulting in an HTTP error with
    a 503 status code.
    • Relevant error logs: ```yaml 1: ##[group]Operating System 2: Ubuntu ... 495: * [new branch] featembed-tool -> origin/featembed-tool 496: * [new branch] fix/readme -> origin/fix/readme 497: * [new branch] fix/readme-logo -> origin/fix/readme-logo 498: * [new branch] fix/swe-agent -> origin/fix/swe-agent 499: * [new branch] ft-add-better-help-text -> origin/ft-add-better-help-text 500: * [new branch] ft-apps-id -> origin/ft-apps-id 501: * [new branch] ft-bring-back-core-sdk -> origin/ft-bring-back-core-sdk 502: * [new branch] ft-did-you-mean -> origin/ft-did-you-mean 503: * [new branch] ft-error-tracking -> origin/ft-error-tracking ... 902: tests/test_cli/test_actions.py::TestListActions::test_list_all[arguments3-exptected_outputs3-unexptected_outputs3] PASSED [ 21%] 903: tests/test_cli/test_actions.py::TestListActions::test_tag_not_found PASSED [ 23%] 904: tests/test_cli/test_actions.py::TestListActions::test_limit SKIPPED [ 26%] 905: tests/test_cli/test_actions.py::TestListActions::test_copy PASSED [ 28%] 906: tests/test_cli/test_add.py::TestComposioAdd::test_no_auth PASSED [ 30%] 907: tests/test_cli/test_apps.py::TestList::test_list PASSED [ 32%] 908: tests/test_cli/test_apps.py::TestUpdate::test_update_not_required PASSED [ 34%] 909: tests/test_cli/test_apps.py::TestUpdate::test_update SKIPPED (Needs 910: investigation, this test fails in CI) [ 36%] 911: tests/test_cli/test_connections.py::TestListConnections::test_list_all FAILED [ 39%] ... 932: tests/test_tools/test_toolset.py::test_find_actions_by_tags PASSED [ 84%] 933: tests/test_tools/test_toolset.py::test_uninitialize_app PASSED [ 86%] 934: tests/test_utils/test_decorators.py::test_deprecated PASSED [ 89%] 935: tests/test_utils/test_git.py::test_get_git_user_info PASSED [ 91%] 936: tests/test_utils/test_shared.py::test_get_pydantic_signature_format_from_schema_params PASSED [ 93%] 937: tests/test_utils/test_shared.py::test_json_schema_to_pydantic_field PASSED [ 95%] 938: tests/test_utils/test_shared.py::test_json_schema_to_fields_dict PASSED [ 97%] 939: tests/test_utils/test_url.py::test_get_web_url PASSED [100%] 940: =================================== FAILURES =================================== 941: ______________________ TestListConnections.test_list_all _______________________ 942: self = 943: def test_list_all(self) -> None: 944: """Test list connections.""" 945: result = self.run("connections") 946: > assert result.exit_code == 0, result.stderr 947: E AssertionError: 948: E assert 1 == 0 949: E + where 1 = \n\n \n \n \n Server Error\n \n \n\n \n
    \n
    \n \n\n')>.exit_code 950: tests/test_cli/test_connections.py:15: AssertionError 951: =============================== warnings summary =============================== 952: composio/client/http.py:18 953: /home/runner/work/composio/composio/python/composio/client/http.py:18: DeprecationWarning: Inheritance class AsyncHttpClient from ClientSession is discouraged 954: class AsyncHttpClient(AsyncSession, logging.WithLogger): 955: .tox/unittests/lib/python3.10/site-packages/pydantic/_internal/_config.py:291 956: /home/runner/work/composio/composio/python/.tox/unittests/lib/python3.10/site-packages/pydantic/_internal/_config.py:291: PydanticDeprecatedSince20: Support for class-based `config` is deprecated, use ConfigDict instead. Deprecated in Pydantic V2.0 to be removed in V3.0. See Pydantic V2 Migration Guide at https://errors.pydantic.dev/2.8/migration/ ... 1091: composio/workspace/workspace_clients.py 191 153 20% 29, 34, 39-40, 43-49, 52-64, 69-96, 99-133, 140-205, 218-246, 254-260, 265-294, 304-322, 325, 339-351, 357-365, 388-416, 420-429, 436-444 1092: composio/workspace/workspace_factory.py 52 25 52% 32-37, 42-44, 52-73, 78, 81-85, 88-89, 92 1093: examples/crewai_ci_chart.py 15 15 0% 1-38 1094: -------------------------------------------------------------------------------------------------------------------- 1095: TOTAL 8006 1339 83% 1096: Coverage HTML written to dir htmlcov 1097: Coverage XML written to file coverage.xml 1098: =========================== short test summary info ============================ 1099: FAILED tests/test_cli/test_connections.py::TestListConnections::test_list_all - AssertionError: 1100: assert 1 == 0 1101: + where 1 = \n\n \n \n \n Server Error\n \n \n\n \n
    \n
    \n \n\n')>.exit_code 1102: ============= 1 failed, 38 passed, 7 skipped, 2 warnings in 22.77s ============= 1103: unittests: exit 1 (23.77 seconds) /home/runner/work/composio/composio/python> pytest -vvv -rfE --doctest-modules composio/ tests/ --cov=composio --cov=examples --cov-report=html --cov-report=xml --cov-report=term --cov-report=term-missing --cov-config=.coveragerc pid=5598 1104: .pkg: _exit> python /opt/hostedtoolcache/Python/3.10.14/x64/lib/python3.10/site-packages/pyproject_api/_backend.py True setuptools.build_meta __legacy__ 1105: unittests: FAIL code 1 (47.30=setup[18.74]+cmd[4.80,23.77] seconds) 1106: evaluation failed :( (47.63 seconds) 1107: ##[error]Process completed with exit code 1. ```
    ✨ CI feedback usage guide:
    The CI feedback tool (`/checks)` automatically triggers when a PR has a failed check. The tool analyzes the failed checks and provides several feedbacks: - Failed stage - Failed test name - Failure summary - Relevant error logs In addition to being automatically triggered, the tool can also be invoked manually by commenting on a PR: ``` /checks "https://github.com/{repo_name}/actions/runs/{run_number}/job/{job_number}" ``` where `{repo_name}` is the name of the repository, `{run_number}` is the run number of the failed check, and `{job_number}` is the job number of the failed check. #### Configuration options - `enable_auto_checks_feedback` - if set to true, the tool will automatically provide feedback when a check is failed. Default is true. - `excluded_checks_list` - a list of checks to exclude from the feedback, for example: ["check1", "check2"]. Default is an empty list. - `enable_help_text` - if set to true, the tool will provide a help message with the feedback. Default is true. - `persistent_comment` - if set to true, the tool will overwrite a previous checks comment with the new feedback. Default is true. - `final_update_message` - if `persistent_comment` is true and updating a previous checks message, the tool will also create a new message: "Persistent checks updated to latest commit". Default is true. See more information about the `checks` tool in the [docs](https://pr-agent-docs.codium.ai/tools/ci_feedback/).