Skip to content

Add feedback tab for dropping center #391

Merged
tarunnjoshi merged 3 commits intodevelopfrom
feat/feedback-tab
Oct 22, 2024
Merged

Add feedback tab for dropping center #391
tarunnjoshi merged 3 commits intodevelopfrom
feat/feedback-tab

Conversation

@belwalshubham
Copy link
Copy Markdown
Collaborator

@belwalshubham belwalshubham commented Oct 22, 2024

Added Feedback tab

image

Summary by CodeRabbit

  • New Features

    • Introduced a new "Feedback" tab in the Dropping Center interface, enhancing user interaction and feedback collection.
  • Bug Fixes

    • No bug fixes were included in this release.
  • Documentation

    • Updated method signatures to reflect the addition of the new tab functionality.

@belwalshubham belwalshubham self-assigned this Oct 22, 2024
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Oct 22, 2024

Walkthrough

The changes in this pull request involve the addition of a new tab labeled "Feedback" to the DroppingCenterService class in the Civi namespace. This modification occurs within the droppingCenterTabset method, where new properties are defined in the $tabConfigs array. The structure and existing functionality of the class remain unchanged, with no alterations to the logic or error handling.

Changes

File Path Change Summary
wp-content/civi-extensions/goonjcustom/Civi/DroppingCenterService.php Added a new "Feedback" tab to the droppingCenterTabset method, including properties like title, module, directive, and template. Updated method signature for droppingCenterTabset.

Possibly related PRs

Suggested reviewers

  • pokhiii
  • tarunnjoshi

🎉 In the code where tabs reside,
A "Feedback" tab now takes a ride.
With properties set, it joins the crew,
Enhancing the service, fresh and new!
Let’s celebrate this little feat,
In the world of code, it’s quite a treat! 🎊


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.

CodeRabbit Configuration 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
Copy Markdown

@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 (1)
wp-content/civi-extensions/goonjcustom/Civi/DroppingCenterService.php (1)

499-504: LGTM: New 'Feedback' tab added successfully

The new 'Feedback' tab has been added correctly, following the existing pattern for other tabs. Good job on maintaining consistency!

Consider refactoring tab configurations to reduce redundancy

The $tabConfigs array contains repetitive structures for each tab. To improve maintainability and adhere to the DRY principle, consider refactoring this into a more concise format. For example:

$commonConfig = [
    'template' => 'CRM/Goonjcustom/Tabs/CollectionCamp.tpl',
    // Add other common properties here
];

$tabConfigs = [
    'materialContribution' => [
        'title' => ts('Material Contribution'),
        'module' => 'afsearchDroppingCenterMaterialContributions',
        'directive' => 'afsearch-dropping-center-material-contributions',
    ],
    // Other tabs...
    'feedback' => [
        'title' => ts('Feedback'),
        'module' => 'afsearchFeedback',
        'directive' => 'afsearch-feedback',
    ],
];

foreach ($tabConfigs as $key => &$config) {
    $config += $commonConfig;
}

This approach would make it easier to add new tabs and maintain existing ones.

Move is_active property out of the loop

The is_active property is set to 1 for all tabs in the loop. To improve efficiency and reduce redundancy, consider moving this property out of the loop:

$commonTabProperties = [
    'is_active' => 1,
    'template' => $config['template'],
];

foreach ($tabConfigs as $key => $config) {
    $tabs[$key] = $commonTabProperties + [
        'id' => $key,
        'title' => $config['title'],
        'module' => $config['module'],
        'directive' => $config['directive'],
    ];

    \Civi::service('angularjs.loader')->addModules($config['module']);
}

This change would make the code more efficient and easier to maintain if the is_active property needs to be changed in the future.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 606da53 and 7f51440.

📒 Files selected for processing (1)
  • wp-content/civi-extensions/goonjcustom/Civi/DroppingCenterService.php (1 hunks)
🧰 Additional context used
📓 Learnings (1)
wp-content/civi-extensions/goonjcustom/Civi/DroppingCenterService.php (4)
Learnt from: belwalshubham
PR: ColoredCow/goonj#338
File: wp-content/civi-extensions/goonjcustom/Civi/DroppingCenterService.php:69-70
Timestamp: 2024-10-09T05:09:50.336Z
Learning: In `DroppingCenterService.php` (PHP, CiviCRM framework), when the `is_active` property remains constant (`1`) for all tabs in the `droppingCenterTabset` method, it's preferred to hardcode `is_active` in the loop instead of including it in the `$tabConfigs` array to reduce redundancy.
Learnt from: belwalshubham
PR: ColoredCow/goonj#338
File: wp-content/civi-extensions/goonjcustom/Civi/DroppingCenterService.php:69-70
Timestamp: 2024-10-09T05:09:49.529Z
Learning: In `DroppingCenterService.php` (PHP, CiviCRM framework), when the `is_active` property remains constant (`1`) for all tabs in the `droppingCenterTabset` method, it's preferred to hardcode `is_active` in the loop instead of including it in the `$tabConfigs` array to reduce redundancy.
Learnt from: belwalshubham
PR: ColoredCow/goonj#338
File: wp-content/civi-extensions/goonjcustom/Civi/DroppingCenterService.php:69-70
Timestamp: 2024-10-07T15:10:46.214Z
Learning: In `DroppingCenterService.php` (PHP, CiviCRM framework), when the `is_active` property remains constant (`1`) for all tabs in the `droppingCenterTabset` method, it's preferred to hardcode `is_active` in the loop instead of including it in the `$tabConfigs` array to reduce redundancy.
Learnt from: belwalshubham
PR: ColoredCow/goonj#338
File: wp-content/civi-extensions/goonjcustom/Civi/DroppingCenterService.php:69-70
Timestamp: 2024-10-09T05:09:48.296Z
Learning: In `DroppingCenterService.php` (PHP, CiviCRM framework), when the `is_active` property remains constant (`1`) for all tabs in the `droppingCenterTabset` method, it's preferred to hardcode `is_active` in the loop instead of including it in the `$tabConfigs` array to reduce redundancy.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants