Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

QM #1474

Merged
merged 3 commits into from
Jan 22, 2025
Merged

QM #1474

merged 3 commits into from
Jan 22, 2025

Conversation

mrT23
Copy link
Collaborator

@mrT23 mrT23 commented Jan 22, 2025

PR Type

Documentation


Description

  • Rebranded "Qodo Merge Pro" to "Qodo Merge" across documentation.

  • Clarified the distinction between "PR-Agent" and "Qodo Merge".

  • Updated installation and usage instructions to reflect rebranding.

  • Enhanced feature descriptions and corrected links in documentation.


Changes walkthrough 📝

Relevant files
Documentation
22 files
data_privacy.md
Updated branding and clarified private repository handling.
+1/-1     
features.md
Rebranded Qodo Merge Pro references in features.                 
+1/-1     
index.md
Updated branding and installation instructions.                   
+2/-2     
index.md
Rebranded Qodo Merge Pro references in FAQ.                           
+2/-2     
index.md
Clarified distinction between PR-Agent and Qodo Merge.     
+38/-43 
azure.md
Updated branding in Azure installation guide.                       
+1/-1     
bitbucket.md
Rebranded Qodo Merge Pro references in Bitbucket guide.   
+1/-1     
index.md
Updated branding and clarified self-hosted instructions. 
+6/-6     
locally.md
Reorganized and clarified local installation instructions.
+52/-41 
pr_agent_pro.md
Rebranded Qodo Merge Pro references and updated installation details.
+13/-13 
data_privacy.md
Updated branding and clarified data privacy details.         
+5/-5     
index.md
Removed redundant overview content.                                           
+0/-95   
pr_agent_pro.md
Rebranded Qodo Merge Pro references and updated feature descriptions.
+12/-12 
custom_labels.md
Updated branding in custom labels documentation.                 
+1/-1     
help.md
Updated branding in help tool documentation.                         
+1/-1     
improve.md
Updated branding and clarified feature availability.         
+2/-2     
index.md
Updated branding in tools index.                                                 
+1/-1     
PR_agent_pro_models.md
Updated branding in model configuration guide.                     
+5/-5     
automations_and_usage.md
Updated branding in automation and usage guide.                   
+2/-2     
configuration_options.md
Updated branding in configuration options guide.                 
+1/-1     
index.md
Updated branding in usage guide index.                                     
+1/-1     
mkdocs.yml
Updated site metadata and navigation for rebranding.         
+4/-4     

Need help?
  • Type /help how to ... in the comments thread for any question about Qodo Merge usage.
  • Check out the documentation for more information.
  • Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🏅 Score: 95
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Content Reordering

    The pip package installation instructions were moved from the top to the bottom of the file. Consider keeping installation methods in consistent order across documentation.

    ## Using pip package
    
    Install the package:
    

    pip install pr-agent

    
    Then run the relevant tool with the script below.
    <br>
    Make sure to fill in the required parameters (`user_token`, `openai_key`, `pr_url`, `command`):
    
    ```python
    from pr_agent import cli
    from pr_agent.config_loader import get_settings
    
    def main():
        # Fill in the following values
        provider = "github" # github/gitlab/bitbucket/azure_devops
        user_token = "..."  #  user token
        openai_key = "..."  # OpenAI key
        pr_url = "..."      # PR URL, for example 'https://github.com/Codium-ai/pr-agent/pull/809'
        command = "/review" # Command to run (e.g. '/review', '/describe', '/ask="What is the purpose of this PR?"', ...)
    
        # Setting the configurations
        get_settings().set("CONFIG.git_provider", provider)
        get_settings().set("openai.key", openai_key)
        get_settings().set("github.user_token", user_token)
    
        # Run the command. Feedback will appear in GitHub PR comments
        cli.run_command(pr_url, command)
    
    
    if __name__ == '__main__':
        main()
    
    
    </details>
    
    </td></tr>
    </table>
    

    @@ -8,7 +8,7 @@ To enable private chat, simply install the Qodo Merge Chrome extension. After in
    This chat session is **private**, and won't be visible to other users.

    All open-source repositories are supported.
    For private repositories, you will also need to install Qodo Merge Pro, After installation, make sure to open at least one new PR to fully register your organization. Once done, you can chat with both new and existing PRs across all installed repositories.
    For private repositories, you will also need to install Qodo Merge, After installation, make sure to open at least one new PR to fully register your organization. Once done, you can chat with both new and existing PRs across all installed repositories.
    Copy link
    Contributor

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Suggestion: Fix sentence punctuation [General, importance: 5]

    Suggested change
    For private repositories, you will also need to install Qodo Merge, After installation, make sure to open at least one new PR to fully register your organization. Once done, you can chat with both new and existing PRs across all installed repositories.
    For private repositories, you will also need to install Qodo Merge. After installation, make sure to open at least one new PR to fully register your organization.

    @mrT23
    Copy link
    Collaborator Author

    mrT23 commented Jan 22, 2025

    /improve

    Copy link
    Contributor

    qodo-merge-pro-for-open-source bot commented Jan 22, 2025

    PR Code Suggestions ✨

    Latest suggestions up to fb3aa8c

    CategorySuggestion                                                                                                                                    Score
    Security
    Add security warning for credentials

    Add a warning about not committing the .env file to version control since it
    contains sensitive credentials. This is a critical security practice.

    docs/docs/installation/locally.md [41-45]

     For example, suppose you want to run `pr_agent` that connects to a self-hosted GitLab instance similar to an example above.
     You can define the environment variables in a plain text file named `.env` with the following content:
    +
    +> Warning: Never commit the `.env` file to version control system as it might contain sensitive credentials!
     

    CONFIG__GIT_PROVIDER="gitlab"
    GITLAB__URL=""

    
    - [ ] **Apply this suggestion** <!-- /improve --apply_suggestion=0 -->
    
    <details><summary>Suggestion importance[1-10]: 8</summary>
    
    Why: Adding a warning about not committing sensitive credentials in .env files to version control is a critical security best practice that can prevent credential leaks and security breaches.
    
    
    </details></details></td><td align=center>8
    
    </td></tr></tr></tbody></table>
    
    ___
    
    #### Previous suggestions
    <details><summary>✅ Suggestions up to commit 983ce13</summary>
    <br><table><thead><tr><td>Category</td><td align=left>Suggestion&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </td><td align=center>Score</td></tr><tbody><tr><td rowspan=1><strong>General</strong></td>
    <td>
    
    
    
    <details><summary>✅ Fix sentence punctuation</summary>
    
    ___
    
    
    **Fix the grammatical error in the sentence by adding a comma after "Qodo Merge"**
    
    [docs/docs/chrome-extension/features.md [11]](https://github.com/Codium-ai/pr-agent/pull/1474/files#diff-97f38891a224130906b208e402f9d9ae64991e8bd3923a96b42eeeaea2fd8f35R11-R11)
    
    ```diff
    -For private repositories, you will also need to install Qodo Merge, After installation, make sure to open at least one new PR to fully register your organization.
    +For private repositories, you will also need to install Qodo Merge. After installation, make sure to open at least one new PR to fully register your organization.
    

    [Suggestion has been applied]

    Suggestion importance[1-10]: 5

    Why: The suggestion correctly identifies and fixes a grammatical error by replacing a comma with a period to properly separate two independent clauses, improving readability.

    5

    @mrT23 mrT23 merged commit 7367c00 into main Jan 22, 2025
    2 checks passed
    @mrT23 mrT23 deleted the tr/docs23 branch January 22, 2025 19:21
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    1 participant