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(contributing): delete old file path #21838

Merged
merged 2 commits into from
Sep 21, 2024
Merged

Conversation

harryMaksim
Copy link
Contributor

@harryMaksim harryMaksim commented Sep 21, 2024

a39869a#diff-755a0b8325879dc97818215ec547e19581667c7ad05742f62a23933b7dd113f9
.github/PULL_REQUEST_TEMPLATE/docs.md has been deleted

Summary by CodeRabbit

  • Documentation
    • Updated the CONTRIBUTING.md file to include docs as a pull request type and clarified the applicability of the default template for various PR types.

@harryMaksim harryMaksim requested a review from a team as a code owner September 21, 2024 03:00
Copy link
Contributor

coderabbitai bot commented Sep 21, 2024

Walkthrough

Walkthrough

The changes made in the CONTRIBUTING.md file involve an update to the pull request (PR) template descriptions. The modification expands the types of PRs to include docs alongside the previously mentioned fix, feat, and refactor. It clarifies that the default template can be used for a broader range of PR types, providing a more comprehensive overview of its applicability. The instruction on how to change the template when previewing a PR has been removed.

Changes

File Change Summary
CONTRIBUTING.md Updated PR template description to include docs as a type and noted additional types available.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Repository
    participant PR_Template

    User->>Repository: Create Pull Request
    Repository->>PR_Template: Use default template
    PR_Template-->>User: Display template with types (fix, feat, refactor, docs)
Loading

Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9d20eb2 and 0adf85a.

Files selected for processing (1)
  • CONTRIBUTING.md (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • CONTRIBUTING.md

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.

CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

Thank you!

@tac0turtle tac0turtle added this pull request to the merge queue Sep 21, 2024
Merged via the queue into cosmos:main with commit 231ee05 Sep 21, 2024
70 checks passed
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.

3 participants