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

Development: Fix link to PR naming convention in template #8596

Merged

Conversation

florian-glombik
Copy link
Contributor

@florian-glombik florian-glombik commented May 14, 2024

Checklist

General

Description

With the new development process the link in the PR template that should lead to the PR naming conventions broke. This is addressed by this PR and updates the link to the guidelines.

Steps for Testing

  1. See that the current link does not work https://docs.artemis.cit.tum.de/dev/development-process#naming-conventions-for-github-pull-requests
  2. See that with the new link you will be forwarded to the correct part of the documentation https://docs.artemis.cit.tum.de/dev/development-process/development-process.html#naming-conventions-for-github-pull-requests

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked






Review Progress

Code Review

  • Code Review 1
  • Code Review 2

@florian-glombik florian-glombik marked this pull request as ready for review May 14, 2024 20:35
@florian-glombik florian-glombik requested a review from a team as a code owner May 14, 2024 20:35
Copy link

coderabbitai bot commented May 14, 2024

Walkthrough

The update involves modifying the URL in the GitHub pull request template to point to a new location within the Artemis documentation. This change ensures that the link directing contributors to the naming conventions for GitHub pull requests is accurate and up-to-date.

Changes

Files Change Summary
.github/PULL_REQUEST_TEMPLATE.md Updated the URL from https://docs.artemis.cit.tum.de/dev/development-process/#naming-conventions-for-github-pull-requests to https://docs.artemis.cit.tum.de/dev/development-process/development-process.html#naming-conventions-for-github-pull-requests

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Out of diff range and nitpick comments (13)
.github/PULL_REQUEST_TEMPLATE.md (13)

Line range hint 4-5: Headings should be surrounded by blank lines for better readability.

-### Checklist
+### Checklist

Line range hint 16-16: Lists should be surrounded by blank lines for better readability.

-#### General
+#### General

Line range hint 24-24: Lists should be surrounded by blank lines for better readability.

-#### Server
+#### Server

Line range hint 35-35: Lists should be surrounded by blank lines for better readability.

-#### Client
+#### Client

Line range hint 51-51: Lists should be surrounded by blank lines for better readability.

-#### Changes affecting Programming Exercises
+#### Changes affecting Programming Exercises

Line range hint 64-64: Lists should be surrounded by blank lines for better readability.

-### Motivation and Context
+### Motivation and Context

Line range hint 73-73: Lists should be surrounded by blank lines for better readability.

-### Description
+### Description

Line range hint 92-92: Lists should be surrounded by blank lines for better readability.

-### Testserver States
+### Testserver States

Line range hint 93-93: Trailing spaces found. Remove trailing spaces for cleaner formatting.

-#### Performance Review 
+#### Performance Review

Line range hint 95-95: Headings should be surrounded by blank lines for better readability.

-#### Code Review
+#### Code Review

Line range hint 98-98: Headings should be surrounded by blank lines for better readability.

-#### Manual Tests
+#### Manual Tests

Line range hint 101-101: Headings should be surrounded by blank lines for better readability.

-### Test Coverage
+### Test Coverage

Line range hint 78-83: Images should have alternate text (alt text) for accessibility.

-![](https://byob.yarr.is/ls1intum/Artemis/artemis-test1)
-![](https://byob.yarr.is/ls1intum/Artemis/artemis-test2)
-![](https://byob.yarr.is/ls1intum/Artemis/artemis-test3)
-![](https://byob.yarr.is/ls1intum/Artemis/artemis-test4)
-![](https://byob.yarr.is/ls1intum/Artemis/artemis-test5)
-![](https://byob.yarr.is/ls1intum/Artemis/artemis-test6)
+![Test Server 1](https://byob.yarr.is/ls1intum/Artemis/artemis-test1)
+![Test Server 2](https://byob.yarr.is/ls1intum/Artemis/artemis-test2)
+![Test Server 3](https://byob.yarr.is/ls1intum/Artemis/artemis-test3)
+![Test Server 4](https://byob.yarr.is/ls1intum/Artemis/artemis-test4)
+![Test Server 5](https://byob.yarr.is/ls1intum/Artemis/artemis-test5)
+![Test Server 6](https://byob.yarr.is/ls1intum/Artemis/artemis-test6)

.github/PULL_REQUEST_TEMPLATE.md Show resolved Hide resolved
@florian-glombik florian-glombik changed the title Development: Fixing link to naming convention in PR template Development: Fix link to naming convention in PR template May 14, 2024
@florian-glombik florian-glombik changed the title Development: Fix link to naming convention in PR template Development: Fix link to PR naming convention in PR template May 14, 2024
Copy link
Contributor

@rabeatwork rabeatwork left a comment

Choose a reason for hiding this comment

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

Thanks!

Copy link
Contributor

@simon-hng simon-hng left a comment

Choose a reason for hiding this comment

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

Amazing change!

@krusche krusche changed the title Development: Fix link to PR naming convention in PR template Development: Fix link to PR naming convention in template May 17, 2024
@krusche krusche merged commit 4eb01fd into develop May 17, 2024
7 of 8 checks passed
@krusche krusche deleted the chore/development/fix-naming-convention-link-in-pr-template branch May 17, 2024 17:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Merged
Development

Successfully merging this pull request may close these issues.

None yet

7 participants