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

chore: fix link in all-contributors bot #281

Merged
merged 1 commit into from
Apr 26, 2024

Conversation

mansenfranzen
Copy link
Owner

@mansenfranzen mansenfranzen commented Apr 26, 2024

Type

enhancement


Description

  • Updated the badge link in the .all-contributorsrc to direct users to the acknowledgements section of the README.
  • Changed the commit type to better reflect the nature of contributions.

Changes walkthrough

Relevant files
Configuration changes
.all-contributorsrc
Update All Contributors Configuration                                       

.all-contributorsrc

  • Updated the badge template link to point to a specific section in the
    GitHub repository.
  • Changed the commit type from "docs" to "contributors".
  • +2/-2     

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

    @mansenfranzen mansenfranzen merged commit 8261254 into main Apr 26, 2024
    28 of 30 checks passed
    @mansenfranzen mansenfranzen deleted the align_all_contributors_bot branch April 26, 2024 10:31
    @github-actions github-actions bot added the enhancement New feature or request label Apr 26, 2024
    Copy link
    Contributor

    PR Description updated to latest commit (521e253)

    Copy link
    Contributor

    PR Review

    ⏱️ Estimated effort to review [1-5]

    2, because the changes are straightforward and limited to configuration updates in a single file. The modifications are clear and involve updating a URL and a commit type.

    🧪 Relevant tests

    No

    🔍 Possible issues

    No

    🔒 Security concerns

    No

    Code feedback:

    ✨ Review tool usage guide:

    Overview:
    The review tool scans the PR code changes, and generates a PR review which includes several types of feedbacks, such as possible PR issues, security threats and relevant test in the PR. More feedbacks can be added by configuring the tool.

    The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.

    • When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:
    /review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...
    
    [pr_reviewer]
    some_config1=...
    some_config2=...
    

    See the review usage page for a comprehensive guide on using this tool.

    Copy link
    Contributor

    PR Code Suggestions

    CategorySuggestions                                                                                                                                                       
    Enhancement
    Replace hardcoded repository URL with a variable in the badge template.

    The URL in the badgeTemplate field is hardcoded to point to a specific repository. It
    would be better to use a variable or a placeholder to make this configuration reusable for
    other repositories.

    .all-contributorsrc [6]

    -"badgeTemplate": "[![All Contributors](https://img.shields.io/badge/all_contributors-<%= contributors.length %>-orange.svg?style=for-the-badge)](https://github.com/mansenfranzen/autodoc_pydantic?tab=readme-ov-file#-acknowledgements)"
    +"badgeTemplate": "[![All Contributors](https://img.shields.io/badge/all_contributors-<%= contributors.length %>-orange.svg?style=for-the-badge)](<%= repoUrl %>#-acknowledgements)"
     
    Best practice
    Verify and document the change in commit type.

    The commitType value has been changed from "docs" to "contributors". Ensure this change
    aligns with the repository's commit conventions and that it is documented in the project's
    contribution guidelines to avoid confusion.

    .all-contributorsrc [519]

    -"commitType": "contributors"
    +"commitType": "contributors"  # Ensure this change is documented and aligns with commit conventions
     

    ✨ Improve tool usage guide:

    Overview:
    The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.

    • When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:
    /improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...
    
    [pr_code_suggestions]
    some_config1=...
    some_config2=...
    

    See the improve usage page for a comprehensive guide on using this tool.

    @github-actions github-actions bot mentioned this pull request Apr 26, 2024
    @mansenfranzen
    Copy link
    Owner Author

    @all-contributors please add @AnneRademacher for financial

    Copy link
    Contributor

    @mansenfranzen

    We had trouble processing your request. Please try again later.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    1 participant