Skip to content

docs: add local testing steps to NestBot development guide#4352

Merged
arkid15r merged 5 commits into
OWASP:mainfrom
omsalunkhe26:add-nestbot-testing-docs
Apr 11, 2026
Merged

docs: add local testing steps to NestBot development guide#4352
arkid15r merged 5 commits into
OWASP:mainfrom
omsalunkhe26:add-nestbot-testing-docs

Conversation

@omsalunkhe26
Copy link
Copy Markdown
Contributor

Resolves #4333

Added a "Testing NestBot Locally" section to help contributors verify their setup.

Includes:

  • running the application using make run
  • testing via direct message and channel mention
  • checking logs using make logs

@github-actions github-actions Bot added the docs Improvements or additions to documentation label Mar 24, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 24, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 771a6159-c53b-450e-bbdc-660d5705099a

📥 Commits

Reviewing files that changed from the base of the PR and between f5cc7fe and 806bf33.

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

Summary by CodeRabbit

  • Documentation
    • Clarified "Testing NestBot Locally" guidance: smoke-test examples reformatted into explicit bullets for verifying via direct message, channel mention, and channel message (when subscribed to channel events). Instructions on starting the local environment and monitoring logs/events remain the same.

Walkthrough

Reformatted the "Testing NestBot Locally" guidance in CONTRIBUTING.md to present smoke-test steps as three explicit bullets: direct message, channel mention, and channel message when subscribed to the message.channels bot event. No commands or log-check instructions were changed.

Changes

Cohort / File(s) Summary
Documentation Updates
CONTRIBUTING.md
Rewrote the smoke-test instruction sentence as a three-item bullet list (direct message, channel mention, channel message when app subscribes to message.channels). Commands and log verification steps left unchanged. (+5/−1)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • kasya
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding local testing steps documentation to the NestBot development guide.
Description check ✅ Passed The description clearly relates to the changeset, detailing the added 'Testing NestBot Locally' section with specific testing steps and log-checking instructions.
Linked Issues check ✅ Passed The pull request fulfills issue #4333 by adding the 'Testing NestBot Locally' subsection with instructions for running the application, testing via direct message and channel mention, and checking logs.
Out of Scope Changes check ✅ Passed All changes are scoped to the CONTRIBUTING.md file and directly address the documentation requirements specified in issue #4333 with no extraneous modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment @coderabbitai help to get the list of available commands and usage tips.

cubic-dev-ai[bot]
cubic-dev-ai Bot previously approved these changes Mar 24, 2026
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

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

No issues found across 1 file

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.

Since this is your first cubic review, here's how it works:

  • cubic automatically reviews your code and comments on bugs and improvements
  • Teach cubic by replying to its comments. cubic learns from your replies and gets better over time
  • Add one-off context when rerunning by tagging @cubic-dev-ai with guidance or docs links (including llms.txt)
  • Ask questions if you need clarification on any suggestion

Copy link
Copy Markdown
Contributor

@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: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@CONTRIBUTING.md`:
- Around line 268-283: Update the markdown under the "Testing NestBot Locally"
subsection: change the h6 heading to the next-level heading (increment by one
from the parent h4) so heading levels are sequential, and ensure the fenced code
block around the make run snippet has a blank line before and after it to
satisfy markdownlint; locate the "Testing NestBot Locally" heading and the
fenced block containing "make run" to apply these adjustments.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: f8245311-c403-457c-a438-4ec68f9f624b

📥 Commits

Reviewing files that changed from the base of the PR and between 5e3d860 and bfc2afd.

📒 Files selected for processing (1)
  • CONTRIBUTING.md

Comment thread CONTRIBUTING.md Outdated
cubic-dev-ai[bot]
cubic-dev-ai Bot previously approved these changes Mar 24, 2026
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

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

0 issues found across 1 file (changes from recent commits).

Copy link
Copy Markdown
Contributor

@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: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@CONTRIBUTING.md`:
- Line 278: Remove the trailing whitespace on the blank line in CONTRIBUTING.md
that triggers markdownlint MD009; open the file, find the empty/blank line
containing extra spaces, trim those spaces so the line is truly empty, save and
re-run linting to ensure the MD009 warning is cleared.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 333712b5-f037-4d32-9c7d-a31f7fd51e88

📥 Commits

Reviewing files that changed from the base of the PR and between bfc2afd and f82790f.

📒 Files selected for processing (1)
  • CONTRIBUTING.md

Comment thread CONTRIBUTING.md Outdated
cubic-dev-ai[bot]
cubic-dev-ai Bot previously approved these changes Mar 24, 2026
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

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

0 issues found across 1 file (changes from recent commits).

Copy link
Copy Markdown
Contributor

@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.

♻️ Duplicate comments (1)
CONTRIBUTING.md (1)

277-278: ⚠️ Potential issue | 🟡 Minor

Add a blank line after the fenced block to satisfy markdownlint.

At Line 277, the closing fence is immediately followed by a list item on Line 278; MD031 expects a blank line there.

Suggested patch
       ```bash
       make run
       ```
+
    1. **Direct Message**: Send a direct message to the bot in your Slack workspace.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@CONTRIBUTING.md` around lines 277 - 278, The closing fenced code block is
immediately followed by a list item which violates MD031; add a single blank
line after the closing triple backticks so the fence is separated from the
following list entry. Locate the closing fence for the code block shown in the
diff and insert one empty line before the "1. **Direct Message**: Send a direct
message to the bot in your Slack workspace." list item to satisfy markdownlint.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Duplicate comments:
In `@CONTRIBUTING.md`:
- Around line 277-278: The closing fenced code block is immediately followed by
a list item which violates MD031; add a single blank line after the closing
triple backticks so the fence is separated from the following list entry. Locate
the closing fence for the code block shown in the diff and insert one empty line
before the "1. **Direct Message**: Send a direct message to the bot in your
Slack workspace." list item to satisfy markdownlint.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 189b763d-db53-4fd5-b14a-d84cbd73983f

📥 Commits

Reviewing files that changed from the base of the PR and between f82790f and f5cc7fe.

📒 Files selected for processing (1)
  • CONTRIBUTING.md

coderabbitai[bot]
coderabbitai Bot previously approved these changes Mar 24, 2026
@sonarqubecloud
Copy link
Copy Markdown

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 11, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.05%. Comparing base (c0efae7) to head (806bf33).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #4352   +/-   ##
=======================================
  Coverage   99.05%   99.05%           
=======================================
  Files         527      527           
  Lines       16882    16882           
  Branches     2320     2320           
=======================================
  Hits        16723    16723           
  Misses         91       91           
  Partials       68       68           
Flag Coverage Δ
backend 99.50% <ø> (ø)
frontend 97.78% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c0efae7...806bf33. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@arkid15r arkid15r added this pull request to the merge queue Apr 11, 2026
Merged via the queue into OWASP:main with commit 2ff55ed Apr 11, 2026
38 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add local testing steps to NestBot development guide

2 participants