docs: add local testing steps to NestBot development guide#4440
docs: add local testing steps to NestBot development guide#4440arkid15r merged 3 commits intoOWASP:mainfrom
Conversation
Closes OWASP#4333 ## Summary Adds missing local testing instructions to the NestBot Development section in CONTRIBUTING.md. ## Changes - Added Testing NestBot Locally subsection - Included make logs command for checking Django events ## Checklist - [x] Documentation only change - [x] No new dependencies added - [x] Improves contributor onboarding experience
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Summary by CodeRabbit
WalkthroughUpdated CONTRIBUTING.md: corrected setup phrasing, expanded Slack app configuration instructions to replace production URLs in the NestBot Slack manifest with the ngrok base URL for slash commands, event subscriptions, and interactivity, and added a "Testing NestBot Locally" section with smoke-test steps and ngrok/logging guidance. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
275-275: Use a fenced bash block formake logsfor reliable rendering.At Line 275,
make logsis currently plain indented text. Wrapping it in a fencedbashblock will render consistently and improve copy/paste usability.Suggested docs diff
- make logs + ```bash + make logs + ```🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CONTRIBUTING.md` at line 275, Wrap the plain indented command make logs in a fenced bash code block in CONTRIBUTING.md so it renders and copies correctly; replace the current indented line containing make logs with a triple-backtick bash block (```bash), the make logs line, and a closing triple-backtick (```) to ensure consistent formatting and syntax highlighting.
🤖 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 267: Add a blank line before the markdown heading "### Testing NestBot
Locally" to satisfy markdownlint MD022; locate the heading text and insert an
empty line directly above it so the subsection is separated from the preceding
list content.
---
Nitpick comments:
In `@CONTRIBUTING.md`:
- Line 275: Wrap the plain indented command make logs in a fenced bash code
block in CONTRIBUTING.md so it renders and copies correctly; replace the current
indented line containing make logs with a triple-backtick bash block (```bash),
the make logs line, and a closing triple-backtick (```) to ensure consistent
formatting and syntax highlighting.
🪄 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: a7a19db9-7348-43ff-bb03-2a719b07172f
📒 Files selected for processing (1)
CONTRIBUTING.md
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4440 +/- ##
=======================================
Coverage 99.05% 99.05%
=======================================
Files 527 527
Lines 16882 16882
Branches 2372 2320 -52
=======================================
Hits 16723 16723
Misses 91 91
Partials 68 68
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
2 participants
Closes #4333
Summary
Adds missing local testing instructions to the NestBot Development section in CONTRIBUTING.md.
Changes
Checklist
STOP AND READ BEFORE SUBMITTING! REMOVE THIS PARAGRAPH BEFORE OPENING THE PR
Thank you for your interest in contributing to OWASP Nest!
Before starting any work, all external contributors must first be assigned to an issue in the repository.
This is a mandatory step in the OWASP Nest workflow and ensures that effort is coordinated, approved, and tracked properly.
Exception: OWASP leaders are not required to follow this rule —- just make sure your username is included in the exception list.
If you were not assigned to the issue you are trying to resolve, stop right now and do NOT create this PR.
Unassigned pull requests are automatically closed by our workflows — please don't waste your time.
If you want to be assigned on any available issue, comment on it and wait for confirmation from the maintainers or project leads.
Proposed change
Resolves #(put the issue number here)
Add the PR description here.
Checklist
make check-testlocally: all warnings addressed, tests passed