Adding contributing guidelines#109
Conversation
|
@Sandeepyadav93 Let me know if anything is missing. As you recently tried it out. |
There was a problem hiding this comment.
Pull request overview
Adds a new CONTRIBUTING.md guide for setting up local development, configuring Slack/inference settings, running the app, and preparing PRs.
Changes:
- Adds contributor setup instructions for virtualenv, dev dependencies, and pre-commit.
- Documents local
.envconfiguration and Slack test-channel setup. - Adds local run/test/check commands, PR checklist, style guidance, and troubleshooting notes.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| 3. Under **OAuth & Permissions**, add these Bot Token Scopes: | ||
| - `channels:history` -- read channel messages | ||
| - `channels:read` -- list channels | ||
| - `chat:write` -- post messages | ||
| - `reactions:write` -- add emoji reactions | ||
| - `app_mentions:read` -- respond to @ mentions (needed for Socket Mode) |
| - **pytest** to verify tests pass | ||
| - **build** to confirm the package installs cleanly | ||
|
|
||
| All of these must pass before your PR can be merged. |
| Create your `.env` by copying the template below and filling in your values: | ||
|
|
||
| ```bash | ||
| # ---- .env ---- |
There was a problem hiding this comment.
Hey Vishnu,
The .env example Mohit provided also included the parameters below. Do we need these as well?
OPENSHIFT_INFERENCE_URL=
OPENSHIFT_INFERENCE_TOKEN=
OPENSHIFT_MODEL=
GENERIC_INFERENCE_URL=
GENERIC_INFERENCE_TOKEN=
GENERIC_MODEL=
DOCLING_INFERENCE_URL=
DOCLING_INFERENCE_TOKEN=
PRODUCT=
CI=
BUGZOOKA_NAMESPACE=
and it didn't had JEDI_BOT_SLACK_USER_ID=""
There was a problem hiding this comment.
I don't think so. Cross checked in the bugzooka deployed instance as well.
|
|
||
| Testing against a production channel is risky -- you don't want your development bot spamming real users. Instead, set up your own isolated test environment. | ||
|
|
||
| ### Step 1: Create a Slack App |
There was a problem hiding this comment.
I wasn't aware that we needed to create our own app. When I ran into issues, I just invited the existing PerfScale Jedi app on my own test channel, and it worked well for me.
Do we really need to create a new app, or can we just reuse and invite the existing PerfScale Jedi?
There was a problem hiding this comment.
A line just below it says, if you don;'t have it already. But for us we have our own instance so can be ignored. Clarified it in the above sentence, if it helps.
Signed-off-by: Vishnu Challa <vchalla@redhat.com>
vishnuchalla
force-pushed
the
contributing
branch
from
8acd523 to
2fd0c67
Compare
|
/lgtm thanks! |
Description
Adding contributing guidelines for local development
Testing
Verified the markdown content in local