fix:Replace Suggestion Badges with Forum Badges #4219

nitinawari · 2025-05-12T09:14:17Z

task a little bit changed
Replaced the previously planned "Suggestion" feature badges with new badges for the "Forum" feature. Removed old suggestion-related badges and their icons. Added a new badge for the first forum post with appropriate icon. Also updated the information on the /features page to reflect this change.

Summary by CodeRabbit

New Features
- Added a "Forum" feature card to the features page, highlighting community-driven feedback and providing direct links to the forum and related resources.
Bug Fixes
- Updated the "Suggest New Feature" link to direct users to the forum instead of the previous suggestions page.
Chores
- Removed the "Suggestions" feature card and related badge.
- Updated badge icons to reflect the new forum feature.

coderabbitai · 2025-05-12T09:14:24Z

Walkthrough

Two Django migration scripts are introduced: one removes the "First Suggestion" badge from the database, and the other adds an icon to the "First Forum Post" badge. Template and static file updates reflect the removal of the suggestions feature and the addition of the forum, including icon list adjustments and features page content changes.

Changes

Files/Paths	Change Summary
website/migrations/0239_remove_first_suggestion_badge.py	Adds a migration to remove the "First Suggestion" badge from the database.
website/migrations/0240_add_first_forum_post_badge_icon.py	Adds a migration to assign an icon to the "First Forum Post" badge, copying the icon file as needed.
website/static/img/badges/icon_names.txt	Removes `icons8-suggestion-64.png` and adds `icons8-forum-96.png` to the icon names list.
website/templates/features.html	Removes the "Suggestions" feature card and related links, adds a "Forum" feature card and updates links.

Sequence Diagram(s)

sequenceDiagram
    participant Migration_239 as Migration 0239
    participant DB as Database

    Migration_239->>DB: Find Badge with title "First Suggestion"
    alt Badge exists
        Migration_239->>DB: Delete "First Suggestion" Badge
    end

sequenceDiagram
    participant Migration_240 as Migration 0240
    participant DB as Database
    participant FS as File System

    Migration_240->>DB: Find Badge with title "First Forum Post"
    alt Badge exists
        Migration_240->>FS: Check if icon file exists in static directory
        alt Icon file exists
            Migration_240->>FS: Copy icon to media/badges directory
            Migration_240->>DB: Assign icon to badge and save
        end
    end

Assessment against linked issues

Objective	Addressed	Explanation
Add a badge for when a user submits a suggestion (#2914)	❌	The migration removes the "First Suggestion" badge instead of adding it.

Tip

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6e2d1d1 and f71b120.

⛔ Files ignored due to path filters (4)

website/static/img/badges/icons8-forum-96.png is excluded by !**/*.png
website/static/img/badges/icons8-suggestion-64.png is excluded by !**/*.png
website/static/img/features/forum.png is excluded by !**/*.png
website/static/img/features/suggestions.png is excluded by !**/*.png

📒 Files selected for processing (4)

website/migrations/0239_remove_first_suggestion_badge.py (1 hunks)
website/migrations/0240_add_first_forum_post_badge_icon.py (1 hunks)
website/static/img/badges/icon_names.txt (1 hunks)
website/templates/features.html (2 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (2)

website/migrations/0239_remove_first_suggestion_badge.py (2)

website/models.py (1)

Badge (1379-1393)

website/migrations/0240_add_first_forum_post_badge_icon.py (1)

Migration (30-37)

website/migrations/0240_add_first_forum_post_badge_icon.py (2)

website/models.py (1)

Badge (1379-1393)

website/migrations/0239_remove_first_suggestion_badge.py (1)

Migration (12-19)

⏰ Context from checks skipped due to timeout of 90000ms (2)

GitHub Check: Run Tests
GitHub Check: docker-test

🔇 Additional comments (7)

website/static/img/badges/icon_names.txt (1)

24-24: Added new forum icon to badge icon list

The new badge icon icons8-forum-96.png has been correctly added to the icon list. This aligns with the PR objective of replacing suggestion badges with forum badges.

website/templates/features.html (2)

23-23: Updated feature suggestion link to point to forum

The "Suggest New Feature" link now correctly points to the forum page (/forum/) instead of the previous suggestion page, maintaining functionality while changing the underlying implementation.

387-405: Added Forum feature card to replace Suggestions

The new Forum feature card follows the established pattern for feature cards and includes all necessary components:

Appropriate image and alt text

Clear title and description

Addition date (2025-02-22)

Relevant action links to view the forum and related commit

The feature description properly emphasizes the community-driven feedback aspect, maintaining the core functionality that was previously provided by Suggestions.

website/migrations/0239_remove_first_suggestion_badge.py (2)

6-9: Clear and effective migration to remove the suggestion badge

This migration function correctly identifies and removes the "First Suggestion" badge from the database. The approach using filter().delete() is appropriate for this operation.

12-19: Well-structured migration class with proper dependencies

The migration class is properly structured with correct dependencies on the previous migration. The operations list correctly executes the badge removal function.

website/migrations/0240_add_first_forum_post_badge_icon.py (2)

11-28: Well-implemented badge icon update migration

The migration correctly:

Retrieves the "First Forum Post" badge

Locates the new forum icon in the static directory

Creates the necessary directory structure in the media directory

Copies the icon file to the media location

Updates the badge with the new icon

The code includes appropriate existence checks and error handling.

30-37: Proper migration structure with correct dependency

The migration class correctly depends on the previous migration that removed the suggestion badge, ensuring proper sequencing of the database changes.

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

fix:removed the suggestion badge and added forum badge

f71b120

coderabbitai bot approved these changes May 12, 2025

View reviewed changes

DonnieBLT approved these changes May 12, 2025

View reviewed changes

DonnieBLT added this pull request to the merge queue May 13, 2025

Merged via the queue into OWASP-BLT:main with commit 931f13f May 13, 2025
13 checks passed

coderabbitai bot mentioned this pull request May 16, 2025

Create a badge that gets auto added to the issue when it is created (Use BLT-Action) #3917

Open

razzasid pushed a commit to razzasid/BLT that referenced this pull request Jul 3, 2025

fix:removed the suggestion badge and added forum badge (OWASP-BLT#4219)

6f7a9ab

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix:Replace Suggestion Badges with Forum Badges #4219

fix:Replace Suggestion Badges with Forum Badges #4219

Uh oh!

nitinawari commented May 12, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented May 12, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

fix:Replace Suggestion Badges with Forum Badges #4219

fix:Replace Suggestion Badges with Forum Badges #4219

Uh oh!

Conversation

nitinawari commented May 12, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented May 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Assessment against linked issues

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

nitinawari commented May 12, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented May 12, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)