Closed ansaqib closed 4 months ago
railway-app[bot]
commented
4 months ago This PR was not deployed automatically as @ansaqib does not have access to the Railway project.
In order to get automatic PR deploys, please add @ansaqib to the project inside the project settings page.
vercel[bot]
commented
4 months ago The latest updates on your projects. Learn more about Vercel for Git ↗︎
| Name | Status | Preview | Comments | Updated (UTC) |
|---|---|---|---|---|
| mr-market | ✅ Ready (Inspect) | Visit Preview | 💬 Add feedback | Mar 19, 2024 11:18am |
github-actions[bot]
commented
4 months ago PR Description updated to latest commit (https://github.com/Hu-Fi/Mr.Market/commit/5e7d4c4b7611adb4a9659925615aa00d1bd0ea03)
github-actions[bot]
commented
4 months ago | ⏱️ Estimated effort to review [1-5] | 1, because the PR primarily involves documentation updates in the README.md file, focusing on grammatical corrections, clarity enhancements, and consistency improvements. These changes are straightforward to review, as they do not involve code logic or functionality adjustments. |
| 🧪 Relevant tests | No |
| 🔍 Possible issues | No |
| 🔒 Security concerns | No |
Utilizing extra instructionsThe `review` tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize. Examples for extra instructions: ``` [pr_reviewer] # /review # extra_instructions=""" In the 'possible issues' section, emphasize the following: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """ ``` Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable. |
How to enable\disable automation- When you first install PR-Agent app, the [default mode](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened) for the `review` tool is: ``` pr_commands = ["/review", ...] ``` meaning the `review` tool will run automatically on every PR, with the default configuration. Edit this field to enable/disable the tool, or to change the used configurations |
Auto-labelsThe `review` tool can auto-generate two specific types of labels for a PR: - a `possible security issue` label, that detects possible [security issues](https://github.com/Codium-ai/pr-agent/blob/tr/user_description/pr_agent/settings/pr_reviewer_prompts.toml#L136) (`enable_review_labels_security` flag) - a `Review effort [1-5]: x` label, where x is the estimated effort to review the PR (`enable_review_labels_effort` flag) |
Extra sub-toolsThe `review` tool provides a collection of possible feedbacks about a PR. It is recommended to review the [possible options](https://pr-agent-docs.codium.ai/tools/review/#enabledisable-features), and choose the ones relevant for your use case. Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example: `require_score_review`, `require_soc2_ticket`, `require_can_be_split_review`, and more. |
Auto-approve PRsBy invoking: ``` /review auto_approve ``` The tool will automatically approve the PR, and add a comment with the approval. To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following: ``` [pr_reviewer] enable_auto_approval = true ``` (this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository) You can also enable auto-approval only if the PR meets certain requirements, such as that the `estimated_review_effort` is equal or below a certain threshold, by adjusting the flag: ``` [pr_reviewer] maximal_review_effort = 5 ``` |
More PR-Agent commands> To invoke the PR-Agent, add a comment using one of the following commands: > - **/review**: Request a review of your Pull Request. > - **/describe**: Update the PR title and description based on the contents of the PR. > - **/improve [--extended]**: Suggest code improvements. Extended mode provides a higher quality feedback. > - **/ask \ |
github-actions[bot]
commented
4 months ago | Category | Suggestions |
| Enhancement |
Ensure consistent capitalization and punctuation for product names.___ **Consider using consistent capitalization for "Mr. Market" throughout the document tomaintain uniformity and professionalism.** [README.md [14]](https://github.com/Hu-Fi/Mr.Market/pull/63/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R14-R14) ```diff -Mr Market is a CeFi crypto bot and the reference exchange oracle for Hu Fi. +Mr. Market is a CeFi crypto bot and the reference exchange oracle for Hu Fi. ``` |
Use subheadings for main functions to improve document structure.___ **To improve readability and maintain a structured document, consider using subheadings forthe main functions of Mr. Market instead of a bulleted list. This change can help in providing detailed explanations for each function in a more organized manner.** [README.md [14-18]](https://github.com/Hu-Fi/Mr.Market/pull/63/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R14-R18) ```diff -Mr Market has three main functions +Mr. Market has three main functions: +### Automated Crypto Bot +- Supports a variety of strategies for arbitrage across CeFi exchanges. + +### Hu Fi Market Making +- Via the [human protocol](https://github.com/humanprotocol/human-protocol) + +### Front End +- Where users can contribute funds to increase the ability to do Hu Fi market making. + ``` | |
Clarify the term "CeFi" at its first mention.___ **For clarity and to avoid potential confusion, consider specifying what "CeFi" stands forat its first mention in the document. Not all readers may be familiar with the term "CeFi" (Centralized Finance).** [README.md [14]](https://github.com/Hu-Fi/Mr.Market/pull/63/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R14-R14) ```diff -Mr Market is a CeFi crypto bot and the reference exchange oracle for Hu Fi. +Mr. Market is a Centralized Finance (CeFi) crypto bot and the reference exchange oracle for Hu Fi. ``` | |
| Possible issue |
Fix the image URL to point to a valid asset.___ **Correct the image URL to ensure it points to a valid asset. The current URL seems to bemissing the repository structure (e.g., 'blob/master/' or 'raw/master/') which is necessary for GitHub to serve the image correctly.** [README.md [22]](https://github.com/Hu-Fi/Mr.Market/pull/63/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R22-R22) ```diff - + ``` |
| Best practice |
Add descriptive alternative text to images for accessibility.___ **To enhance the document's accessibility and inclusivity, consider adding alternative textdescriptions for all images. This practice helps visually impaired users understand the content conveyed by images.** [README.md [22]](https://github.com/Hu-Fi/Mr.Market/pull/63/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R22-R22) ```diff - + ``` |
Enabling\disabling automationWhen you first install the app, the [default mode](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened) for the improve tool is: ``` pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...] ``` meaning the `improve` tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically. |
Utilizing extra instructionsExtra instructions are very important for the `improve` tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on. Examples for extra instructions: ``` [pr_code_suggestions] # /improve # extra_instructions=""" Emphasize the following aspects: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """ ``` Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable. |
A note on code suggestions quality- While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically. - Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base. - Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the [custom suggestions :gem:](https://pr-agent-docs.codium.ai/tools/custom_suggestions/) tool - With large PRs, best quality will be obtained by using 'improve --extended' mode. |
More PR-Agent commands> To invoke the PR-Agent, add a comment using one of the following commands: > - **/review**: Request a review of your Pull Request. > - **/describe**: Update the PR title and description based on the contents of the PR. > - **/improve [--extended]**: Suggest code improvements. Extended mode provides a higher quality feedback. > - **/ask \ |
github-actions[bot]
commented
4 months ago PR Description updated to latest commit (https://github.com/Hu-Fi/Mr.Market/commit/5e7d4c4b7611adb4a9659925615aa00d1bd0ea03)
github-actions[bot]
commented
4 months ago PR Description updated to latest commit (https://github.com/Hu-Fi/Mr.Market/commit/5e7d4c4b7611adb4a9659925615aa00d1bd0ea03)
github-actions[bot]
commented
4 months ago Persistent review updated to latest commit https://github.com/Hu-Fi/Mr.Market/commit/5e7d4c4b7611adb4a9659925615aa00d1bd0ea03
github-actions[bot]
commented
4 months ago | Category | Suggestions |
| Enhancement |
Improve consistency in naming conventions.___ **Consider using consistent capitalization for "Mr. Market" to improve readability andmaintain consistency throughout the document.** [README.md [14]](https://github.com/Hu-Fi/Mr.Market/pull/63/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R14-R14) ```diff -Mr Market is a CeFi crypto bot and the reference exchange oracle for Hu Fi. Mr Market has three main functions +Mr. Market is a CeFi crypto bot and the reference exchange oracle for Hu Fi. Mr. Market has three main functions ``` |
Enhance readability by breaking down complex explanations into bullet points or shorter paragraphs.___ **To enhance readability, consider breaking down the long paragraph into smaller paragraphsor bullet points, especially when describing the characteristics of the crypto markets and the decentralized approach of HuFi.** [README.md [24]](https://github.com/Hu-Fi/Mr.Market/pull/63/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R24-R24) ```diff -The crypto markets are characterized by their fragmented markets, where each cryptocurrency product on every exchange often requires its own market-making. Some products are quoted in USD, USDC, USDT, or even foreign currencies. In essence, each crypto exchange has an isolated order book for each trading pair. In addition, derivative and future products are also disjointed. This differs from traditional markets, which have regulated, centralized market-making where the futures markets are well hedged. In the crypto sector, each product must manage its market-making independently in a one-off manner on each exchange it launches on. Market making is a lucrative industry but it’s currently only available to the largest crypto actors and the average crypto user has no way to participate. Projects create one off agreements between market makers potentially with a subset of the exchanges they trade on. Recently DeFi markets have allowed for some programmatic market making directly from solidity but they represent a tiny fraction of the overall crypto market. +The crypto markets are characterized by their fragmented markets: +- Each cryptocurrency product on every exchange often requires its own market-making. +- Products may be quoted in USD, USDC, USDT, or even foreign currencies. +- Each crypto exchange has an isolated order book for each trading pair. +- Derivative and future products are disjointed. +This differs from traditional markets, which have regulated, centralized market-making. In the crypto sector, each product must manage its market-making independently on each exchange it launches on. Market making is a lucrative industry but currently only available to the largest crypto actors. Recently, DeFi markets have allowed for some programmatic market making directly from solidity, but they represent a tiny fraction of the overall crypto market. + ``` | |
Add an overview section for a quick introduction to Mr. Market.___ **Add a brief introduction or overview section at the beginning of the README to providereaders with a quick summary of what Mr. Market is and its purpose before diving into detailed descriptions.** [README.md [1]](https://github.com/Hu-Fi/Mr.Market/pull/63/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R1-R1) ```diff +Mr. Market is an innovative CeFi crypto bot designed to revolutionize market making in the cryptocurrency sector. This document provides an overview of its features, usage, and contribution guidelines. + This is highly alpha code. Do not use it or you will lose all your money. We'd like to thank Little creatures for being the first company to test Mr. Market and for helping with QA. ``` | |
| Possible issue |
Correct the image URL to point to a valid location.___ **Correct the URL for the image to ensure it points to a valid location. The current URLseems to be missing a directory in its path.** [README.md [22]](https://github.com/Hu-Fi/Mr.Market/pull/63/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R22-R22) ```diff - + ``` |
| Best practice |
Ensure consistency and clarity in the use of industry-specific terms.___ **Ensure consistency in terminology, especially with industry-specific terms like "CeFi" and"DeFi". Choose one format and stick with it throughout the document.** [README.md [14]](https://github.com/Hu-Fi/Mr.Market/pull/63/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R14-R14) ```diff -Mr Market is a CeFi crypto bot and the reference exchange oracle for Hu Fi. Mr Market has three main functions +Mr. Market is a CeFi (Centralized Finance) crypto bot and the reference exchange oracle for Hu Fi. Mr. Market has three main functions ``` |
Enabling\disabling automationWhen you first install the app, the [default mode](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened) for the improve tool is: ``` pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...] ``` meaning the `improve` tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically. |
Utilizing extra instructionsExtra instructions are very important for the `improve` tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on. Examples for extra instructions: ``` [pr_code_suggestions] # /improve # extra_instructions=""" Emphasize the following aspects: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """ ``` Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable. |
A note on code suggestions quality- While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically. - Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base. - Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the [custom suggestions :gem:](https://pr-agent-docs.codium.ai/tools/custom_suggestions/) tool - With large PRs, best quality will be obtained by using 'improve --extended' mode. |
More PR-Agent commands> To invoke the PR-Agent, add a comment using one of the following commands: > - **/review**: Request a review of your Pull Request. > - **/describe**: Update the PR title and description based on the contents of the PR. > - **/improve [--extended]**: Suggest code improvements. Extended mode provides a higher quality feedback. > - **/ask \ |
github-actions[bot]
commented
4 months ago Persistent review updated to latest commit https://github.com/Hu-Fi/Mr.Market/commit/5e7d4c4b7611adb4a9659925615aa00d1bd0ea03
github-actions[bot]
commented
4 months ago | Category | Suggestions |
| Maintainability |
Ensure consistent capitalization and punctuation for product names.___ **Consider using consistent capitalization for "Mr. Market" throughout the document tomaintain uniformity and professionalism.** [README.md [14]](https://github.com/Hu-Fi/Mr.Market/pull/63/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R14-R14) ```diff -Mr Market is a CeFi crypto bot and the reference exchange oracle for Hu Fi. +Mr. Market is a CeFi crypto bot and the reference exchange oracle for Hu Fi. ``` |
Standardize terminology for clarity and professionalism.___ **Ensure consistent use of terminology, specifically "CeFi" vs. "cefi" and "crypto bot" vs."crypto bot."** [README.md [16]](https://github.com/Hu-Fi/Mr.Market/pull/63/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R16-R16) ```diff -- An automated crypto bot that supports a variety of strategies for arbitrage across CeFi exchanges. +- An automated CeFi crypto bot that supports a variety of strategies for arbitrage across CeFi exchanges. ``` | |
| Bug |
Correct the image URL to ensure it's accessible.___ **Update the image URL to use a consistent and correct path format, ensuring it'saccessible.** [README.md [22]](https://github.com/Hu-Fi/Mr.Market/pull/63/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R22-R22) ```diff - + ``` |
| Enhancement |
Improve list readability by adding newlines between items.___ **Add a newline between list items for better readability and to adhere to Markdown bestpractices.** [README.md [16-17]](https://github.com/Hu-Fi/Mr.Market/pull/63/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R16-R17) ```diff - An automated crypto bot that supports a variety of strategies for arbitrage across CeFi exchanges. + - Hu Fi Market Making via the [human protocol](https://github.com/humanprotocol/human-protocol) ``` |
Specify the technology used for the frontend user interface.___ **For clarity and detail, consider specifying the programming language or framework for thefrontend user interface of Mr. Market.** [README.md [30]](https://github.com/Hu-Fi/Mr.Market/pull/63/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R30-R30) ```diff -The frontend user interface for Mr. Market on Mixin. +The frontend user interface for Mr. Market on Mixin, developed using React. ``` |
Enabling\disabling automationWhen you first install the app, the [default mode](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened) for the improve tool is: ``` pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...] ``` meaning the `improve` tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically. |
Utilizing extra instructionsExtra instructions are very important for the `improve` tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on. Examples for extra instructions: ``` [pr_code_suggestions] # /improve # extra_instructions=""" Emphasize the following aspects: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """ ``` Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable. |
A note on code suggestions quality- While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically. - Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base. - Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the [custom suggestions :gem:](https://pr-agent-docs.codium.ai/tools/custom_suggestions/) tool - With large PRs, best quality will be obtained by using 'improve --extended' mode. |
More PR-Agent commands> To invoke the PR-Agent, add a comment using one of the following commands: > - **/review**: Request a review of your Pull Request. > - **/describe**: Update the PR title and description based on the contents of the PR. > - **/improve [--extended]**: Suggest code improvements. Extended mode provides a higher quality feedback. > - **/ask \ |
github-actions[bot]
commented
4 months ago PR Description updated to latest commit (https://github.com/Hu-Fi/Mr.Market/commit/5e7d4c4b7611adb4a9659925615aa00d1bd0ea03)
github-actions[bot]
commented
4 months ago Persistent review updated to latest commit https://github.com/Hu-Fi/Mr.Market/commit/5e7d4c4b7611adb4a9659925615aa00d1bd0ea03
github-actions[bot]
commented
4 months ago | Category | Suggestions |
| Maintainability |
Ensure consistent capitalization for proper nouns.___ **Consider using consistent capitalization for "Mr. Market" to maintain uniformitythroughout the document. Inconsistent capitalization can confuse readers or imply that different entities are being discussed.** [README.md [14]](https://github.com/Hu-Fi/Mr.Market/pull/63/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R14-R14) ```diff -Mr Market is a CeFi crypto bot and the reference exchange oracle for Hu Fi. Mr Market has three main functions +Mr. Market is a CeFi crypto bot and the reference exchange oracle for Hu Fi. Mr. Market has three main functions ``` |
| Possible issue |
Correct the image URL to ensure it displays properly in the README.___ **The image URL seems to be incorrect or not following a standard pattern. It's missing the'raw.githubusercontent.com' part which is usually required to display images from a GitHub repository in markdown files.** [README.md [22]](https://github.com/Hu-Fi/Mr.Market/pull/63/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R22-R22) ```diff - + ``` |
| Enhancement |
Use bullet points for listing main functions to improve readability.___ **To improve readability and maintain a consistent structure, consider using bullet pointsfor the main functions of Mr. Market. This will make it easier for readers to quickly understand the key features.** [README.md [14]](https://github.com/Hu-Fi/Mr.Market/pull/63/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R14-R14) ```diff -Mr Market is a CeFi crypto bot and the reference exchange oracle for Hu Fi. Mr Market has three main functions +Mr. Market is a CeFi crypto bot and the reference exchange oracle for Hu Fi. Mr. Market has the following main functions: +- An automated crypto bot that supports a variety of strategies for arbitrage across CeFi exchanges. +- Hu Fi Market Making via the [human protocol](https://github.com/humanprotocol/human-protocol) +- A front end where users can contribute funds to increase the ability to do Hu Fi market making. ``` |
Break long paragraphs into smaller ones to enhance readability.___ **The description of HuFi's approach to market-making is quite lengthy and could benefitfrom being broken into smaller paragraphs. This would enhance readability and make the text more digestible for readers.** [README.md [26]](https://github.com/Hu-Fi/Mr.Market/pull/63/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R26-R26) ```diff -HuFi introduces a decentralized approach to market-making, enabling anyone with tokens and code to programmatically engage in market-making on any centralized exchange using Solidity. The code for market-making can be directly embedded in the crypto product itself, or externally with a sidecar market-making product. Additionally, anyone with exchange keys and the ability to run a bot can now become a market maker safely and transparently. Finally, anyone with excess crypto funds can earn income by providing it to the bot to generate yield on this excess crypto. +HuFi introduces a decentralized approach to market-making, enabling anyone with tokens and code to programmatically engage in market-making on any centralized exchange using Solidity. +The code for market-making can be directly embedded in the crypto product itself, or externally with a sidecar market-making product. + +Additionally, anyone with exchange keys and the ability to run a bot can now become a market maker safely and transparently. Finally, anyone with excess crypto funds can earn income by providing it to the bot to generate yield on this excess crypto. + ``` | |
Provide a definition for specialized terms when first introduced.___ **The introduction of the term "CeFi" (Centralized Finance) could be confusing to readersunfamiliar with the term. Consider adding a brief explanation or definition the first time it is used to make the document more accessible to a wider audience.** [README.md [14]](https://github.com/Hu-Fi/Mr.Market/pull/63/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R14-R14) ```diff -Mr Market is a CeFi crypto bot and the reference exchange oracle for Hu Fi. Mr Market has three main functions +Mr. Market is a CeFi (Centralized Finance) crypto bot and the reference exchange oracle for Hu Fi. Mr. Market has three main functions ``` |
Enabling\disabling automationWhen you first install the app, the [default mode](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened) for the improve tool is: ``` pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...] ``` meaning the `improve` tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically. |
Utilizing extra instructionsExtra instructions are very important for the `improve` tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on. Examples for extra instructions: ``` [pr_code_suggestions] # /improve # extra_instructions=""" Emphasize the following aspects: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """ ``` Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable. |
A note on code suggestions quality- While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically. - Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base. - Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the [custom suggestions :gem:](https://pr-agent-docs.codium.ai/tools/custom_suggestions/) tool - With large PRs, best quality will be obtained by using 'improve --extended' mode. |
More PR-Agent commands> To invoke the PR-Agent, add a comment using one of the following commands: > - **/review**: Request a review of your Pull Request. > - **/describe**: Update the PR title and description based on the contents of the PR. > - **/improve [--extended]**: Suggest code improvements. Extended mode provides a higher quality feedback. > - **/ask \ |
Type
documentation, enhancement
Description
Changes walkthrough
README.md
Improved README for Clarity and ConsistencyREADME.md
crypto markets.
decentralized market-making approach.