fix: clean example config and env template for onboarding (Week 4)

[shubham5080]

Summary

• config/example.yaml: data_dir: "./data" (matches INSTALLATION.md); remove castro repo_contributor_roles leftover; document as commented example
• .env.example: add comments for both tokens
• tests/test_readme_setup.py: align with ./data template default

Small, focused PR for template cleanup after validation lands.

Test plan

• pytest tests/test_readme_setup.py -v
• Copy config/example.yaml → config/config.yaml; confirm reports land under ./data/reports/
• ghdcbot validate no longer fails on spurious castro role from template

Depends on

• Validation PR (stacked on docs: unify installation guide and onboarding documentation (Week 4) #23)

Made with Cursor

Summary by CodeRabbit

• New Features

  • Added optional Discord notification events for pull request closures, pull request reopenings, and issue reopenings.
  • Added configuration support for mapping repository names to Discord role assignments.

• Documentation

  • Enhanced environment variable setup instructions with clearer guidance on token configuration.
  • Improved configuration file comments and organization.

• Configuration

  • Changed default data directory from an absolute path to a relative path.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

🗂️ Base branches to auto review (2)

• main
• develop

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: bc7b3e56-eeaf-4d9a-a298-2b7a1265354f

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch week-4-pr3-ux

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@config/example.yaml`:
- Around line 54-58: The example configuration file contains event flags that
are not yet implemented in the notification system: pr_closed, pr_reopened, and
issue_reopened. Remove these three unsupported event flag lines from the example
configuration file to prevent users from configuring non-functional options.
Keep only the event flags that are actually implemented and supported by the
notification system.

🪄 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: ASSERTIVE

Plan: Pro

Run ID: 7efbf765-ac6f-4593-88d3-06b20970ae00

📥 Commits

Reviewing files that changed from the base of the PR and between a11b617 and 01f0b74.

📒 Files selected for processing (3)

• .env.example
• config/example.yaml
• tests/test_readme_setup.py

[coderabbitai]

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Search for notification event handler implementations

# Search for event flag usage in notification-related code
rg -n --type=py -C3 'pr_closed|pr_reopened|issue_reopened' \
  --glob '!config/example.yaml' \
  --glob '!tests/**'

Repository: AOSSIE-Org/Gitcord-GithubDiscordBot

Length of output: 61

---

Remove unsupported event flags from the example configuration.

The newly added event flags pr_closed, pr_reopened, and issue_reopened in the example configuration are not implemented in the notification system. Users configuring these flags will experience silent failures or unexpected behavior. Either implement these events or remove them from the example.

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@config/example.yaml` around lines 54 - 58, The example configuration file
contains event flags that are not yet implemented in the notification system:
pr_closed, pr_reopened, and issue_reopened. Remove these three unsupported event
flag lines from the example configuration file to prevent users from configuring
non-functional options. Keep only the event flags that are actually implemented
and supported by the notification system.