develop branch - coderabbit yaml file

[pranshugupta54]

What kind of change does this PR introduce?

Feature

Issue Number:

Fixes #1990

Did you add tests for your changes?

NA

Snapshots/Videos:

NA

If relevant, did you update the documentation?

NA

Summary

Added YAML Config file for CodeRabbit AI using docs- https://docs.coderabbit.ai/guides/configure-coderabbit

Does this PR introduce a breaking change?

NA

Other information

NA

Have you read the contributing guide?

Yes

Summary by CodeRabbit

• Chores
  • Added configuration settings for the YAML language server to enhance development workflow.
  • Included .prettierrc and .prettierignore files to standardize code formatting.
  • Updated workflow to include .coderabbit.yaml in the list of unauthorized files.

[coderabbitai]

Walkthrough

The recent updates introduce a .coderabbit.yaml file to configure settings for CodeRabbit AI and modify the GitHub workflow for pull requests. This includes adding configuration files for Prettier and restricting unauthorized files.

Changes

Files/Paths	Change Summary
.coderabbit.yaml	Introduced configuration settings for CodeRabbit AI, enabling features like early access, review settings, and chat auto-reply.
.github/workflows/pull-request.yml	Added .prettierrc and .prettierignore files. Included .coderabbit.yaml in the list of unauthorized files.

Assessment against linked issues

Objective (Issue #1990)	Addressed	Explanation
Configure using CodeRabbit YAML File	✅
Use documentation for configuration	✅

In the meadow where code does play,
A rabbit hops in a curious way.
With YAML in paw, it configures the night,
Ensuring code reviews are ever so bright.
Prettier files join the dance,
Making pull requests a smoother chance.
🐇✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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.

[github-actions]

Our Pull Request Approval Process

We have these basic policies to make the approval process smoother for our volunteer team.

Testing Your Code

Please make sure your code passes all tests. Our test code coverage system will fail if these conditions occur:

1. The overall code coverage drops below the target threshold of the repository
2. Any file in the pull request has code coverage levels below the repository threshold
3. Merge conflicts

The process helps maintain the overall reliability of the code base and is a prerequisite for getting your PR approved. Assigned reviewers regularly review the PR queue and tend to focus on PRs that are passing.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

1. comments in this PR or
2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

1. arbitrators of future discussions with other contributors about the validity of your changes
2. point of contact for evaluating the validity of your work
3. person who verifies matching issues by others that should be closed.
4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

1. PRs with issues not assigned to you will be closed by the reviewer
2. Fix the first comment in the PR so that each issue listed automatically closes

Other

1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
2. Read the CONTRIBUTING.md file make

[coderabbitai]

Actionable comments posted: 0

Out of diff range and nitpick comments (1)

.github/workflows/pull-request.yml (1)

Line range hint 73-78: Security Improvement: Avoid direct use of github context data in scripts.

-          FULL_BRANCH_NAME=${{ github.base_ref }}
-          echo "FULL_Branch_NAME: $FULL_BRANCH_NAME"
-          
-          # Clone the specified repository using the extracted branch name
-          git clone --branch $FULL_BRANCH_NAME https://github.com/PalisadoesFoundation/talawa-api && ls -a 
+          env:
+            FULL_BRANCH_NAME: ${{ github.base_ref }}
+          run: |
+            echo "FULL_BRANCH_NAME: $FULL_BRANCH_NAME"
+            git clone --branch "$FULL_BRANCH_NAME" https://github.com/PalisadoesFoundation/talawa-api && ls -a

Use an environment variable to store the branch name and ensure to use double quotes around the variable when used in the script to prevent potential code injection.

Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f5c4099 and 2e0a2c2.

Files selected for processing (2)

• .coderabbit.yaml (1 hunks)
• .github/workflows/pull-request.yml (1 hunks)

Files skipped from review due to trivial changes (1)

• .coderabbit.yaml

Additional comments not posted (1)

.github/workflows/pull-request.yml (1)

101-102: The addition of .prettierrc, .prettierignore, and .coderabbit.yaml to the list of unauthorized files is a good practice to ensure these configuration files are not altered without proper review.

Also applies to: 109-109

[Cioppolo14]

@noman2002 @tasneemkoushar Can you review this PR?

[pranshugupta54]

Reference: #1991