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: Update pull_request_template.md #1382

Merged
merged 1 commit into from
Nov 15, 2024
Merged

Conversation

LeifHelstad
Copy link
Contributor

@LeifHelstad LeifHelstad commented Nov 15, 2024

Hva er endret?

Dokumentasjon / Storybook / testdekning

  • Dokumentasjon er oppdatert eller ikke relevant / nødvendig.
  • Ny komponent har en eller flere stories i Storybook, eller så er ikke dette relevant.
  • Det er blitt lagt til nye tester / eksiterende tester er blitt utvidet, eller tester er ikke relevant.

Skjermbilder eller GIFs (valgfritt)

Summary by CodeRabbit

  • New Features

    • Introduced a "Related Issue(s)" section in the pull request template to improve documentation by linking pull requests to specific issues.
  • Style

    • Minor formatting adjustment to ensure proper line endings in the template.

@LeifHelstad LeifHelstad requested review from a team as code owners November 15, 2024 13:15
Copy link

coderabbitai bot commented Nov 15, 2024

📝 Walkthrough

Walkthrough

The changes introduce a new section titled "Related Issue(s)" in the pull request template located in the .github directory. This section includes a placeholder for an issue number, aimed at improving the documentation of pull requests by linking them to specific issues. Additionally, a minor formatting adjustment was made to ensure a comment line ends with a newline character, while the overall structure and content of the template remain unchanged.

Changes

File Path Change Summary
.github/pull_request_template.md Added "Related Issue(s)" section with a placeholder for an issue number; adjusted a comment line to end with a newline character.

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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: 0

🧹 Outside diff range and nitpick comments (2)
.github/pull_request_template.md (2)

6-9: Consider enhancing the Related Issues section

While adding issue tracking is valuable, consider these improvements:

  1. Maintain language consistency by using Norwegian ("Relaterte saker")
  2. Add guidance for multiple issues
  3. Include brief usage instructions
-## Related Issue(s)
-
-#{issue number}
+## Relaterte saker
+<!--- Legg til issue-nummer som denne PR-en løser eller er relatert til. Fjern denne linjen hvis ingen issues er relevante. -->
+- #{issue-nummer}
+<!-- For flere issues, legg til flere linjer -->

Line range hint 1-18: Consider enhancing template with additional guidance

The template structure is solid, but consider these enhancements to improve PR quality:

  1. Add a section for breaking changes
  2. Include a reviewer checklist
  3. Add links to relevant documentation (e.g., coding standards, test guidelines)

Example additions:

## Breaking Changes
<!--- Hvis endringene dine inneholder breaking changes, beskriv dem her og hvordan andre utviklere bør håndtere dem -->

## For Reviewers
<!--- Sjekkliste for reviewers -->
- [ ] Koden følger våre kodestandarder
- [ ] Endringene er godt dokumentert
- [ ] Testene er dekkende

## Nyttige Lenker
- [Kodestandarder](link-to-standards)
- [Testveiledning](link-to-test-guidelines)
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1b38986 and c88b7cd.

📒 Files selected for processing (1)
  • .github/pull_request_template.md (2 hunks)
🔇 Additional comments (1)
.github/pull_request_template.md (1)

18-18: LGTM!

The newline addition ensures consistent rendering across platforms.

@LeifHelstad LeifHelstad changed the title Update pull_request_template.md chore: Update pull_request_template.md Nov 15, 2024
@LeifHelstad LeifHelstad merged commit 0e549dc into main Nov 15, 2024
22 of 24 checks passed
@LeifHelstad LeifHelstad deleted the LeifHelstad-patch-1 branch November 15, 2024 13:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants