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

PR template: fix path to CONTRIBUTING.md #233

Merged
merged 3 commits into from
Jul 2, 2024

Conversation

mr-c
Copy link
Contributor

@mr-c mr-c commented Jun 21, 2024

User description

Describe the change

PR checklist


PR Type

documentation


Description

  • Fixed the path to CONTRIBUTING.md in the PR checklist to ensure correct linking.
  • Updated the link to the contributing guidelines and the contributors section in the PR template.

Changes walkthrough 📝

Relevant files
Documentation
PULL_REQUEST_TEMPLATE.md
Fix path to CONTRIBUTING.md in PR template                             

.github/PULL_REQUEST_TEMPLATE.md

  • Fixed the path to CONTRIBUTING.md in the PR checklist.
  • Updated the link to the contributing guidelines and contributors
    section.
  • +2/-2     

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

    @mr-c mr-c marked this pull request as ready for review June 24, 2024 18:01
    @codiumai-pr-agent-pro codiumai-pr-agent-pro bot added documentation Improvements or additions to documentation Review effort [1-5]: 1 labels Jun 24, 2024
    Copy link
    Contributor

    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 [1-5] 1
    🧪 Relevant tests No
    🔒 Security concerns No
    ⚡ Key issues to review None

    Copy link
    Contributor

    codiumai-pr-agent-pro bot commented Jun 24, 2024

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Best practice
    ✅ Use an absolute path for the link to the CONTRIBUTING.md file
    Suggestion Impact:The suggestion to use an absolute path for the link to the CONTRIBUTING.md file was implemented in the commit.

    code diff:

    -- [ ] I have read and followed [OpenMS Documentation Contributing guidelines](.github/CONTRIBUTING.md).
    +- [ ] I have read and followed [OpenMS Documentation Contributing guidelines](/.github/CONTRIBUTING.md).
     - [ ] I have attached a screenshot of the relevant area after this change.
     - [ ] `CHANGELOG.md` is updated.
    -- [ ] I have added my name in [CONTRIBUTING.md](.github/CONTRIBUTING.md#openms-documentation-contributors).
    +- [ ] I have added my name in [CONTRIBUTING.md](/.github/CONTRIBUTING.md#openms-documentation-contributors).

    The link to the CONTRIBUTING.md file should use an absolute path to ensure it works
    correctly regardless of the current directory context.

    .github/PULL_REQUEST_TEMPLATE.md [18]

    -- [ ] I have read and followed [OpenMS Documentation Contributing guidelines](.github/CONTRIBUTING.md).
    +- [ ] I have read and followed [OpenMS Documentation Contributing guidelines](/.github/CONTRIBUTING.md).
     
    • Apply this suggestion
    Suggestion importance[1-10]: 7

    Why: The suggestion correctly identifies the need for an absolute path to ensure the link works in any directory context, which is a good practice for markdown files in repositories.

    7
    ✅ Use an absolute path for the link to the CONTRIBUTING.md file with the anchor
    Suggestion Impact:The suggestion to use an absolute path for the link to the CONTRIBUTING.md file with the anchor was implemented in the commit.

    code diff:

    -- [ ] I have added my name in [CONTRIBUTING.md](.github/CONTRIBUTING.md#openms-documentation-contributors).
    +- [ ] I have added my name in [CONTRIBUTING.md](/.github/CONTRIBUTING.md#openms-documentation-contributors).

    The link to the CONTRIBUTING.md file with the anchor should use an absolute path to ensure
    it works correctly regardless of the current directory context.

    .github/PULL_REQUEST_TEMPLATE.md [21]

    -- [ ] I have added my name in [CONTRIBUTING.md](.github/CONTRIBUTING.md#openms-documentation-contributors).
    +- [ ] I have added my name in [CONTRIBUTING.md](/.github/CONTRIBUTING.md#openms-documentation-contributors).
     
    • Apply this suggestion
    Suggestion importance[1-10]: 7

    Why: Similar to the first suggestion, this one also correctly advises using an absolute path for the link with an anchor, ensuring it remains functional regardless of the directory context.

    7

    mr-c and others added 2 commits June 24, 2024 20:03
    Co-authored-by: codiumai-pr-agent-pro[bot] <151058649+codiumai-pr-agent-pro[bot]@users.noreply.github.com>
    Co-authored-by: codiumai-pr-agent-pro[bot] <151058649+codiumai-pr-agent-pro[bot]@users.noreply.github.com>
    @timosachsenberg
    Copy link
    Contributor

    thanks!

    @timosachsenberg timosachsenberg merged commit c498d86 into develop Jul 2, 2024
    1 check passed
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    documentation Improvements or additions to documentation Review effort [1-5]: 1
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants