Skip to content

Conversation

@xecdev
Copy link
Collaborator

@xecdev xecdev commented Sep 12, 2025

Adds contact email to the readme.

Test plan:

  • Validate/preview here.

Summary by CodeRabbit

  • Documentation
    • Added an Email contact link under the Documentation & Support section, providing a direct mailto link to contact@paybutton.org placed after the Website link.
    • Improves visibility of support options and makes it easier for users to reach the team for assistance or inquiries.
    • No other content changes; structure and existing links remain unchanged.

@coderabbitai
Copy link

coderabbitai bot commented Sep 12, 2025

Walkthrough

Adds an Email contact bullet to README.txt under Documentation & Support, placed after the Website link.

Changes

Cohort / File(s) Summary
Documentation
README.txt
Inserted an Email contact bullet ("Email: mailto:contact@paybutton.org") under Documentation & Support, positioned after the Website link. No other edits.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A nibble of text, a tidy delight,
I hopped through README in moonlit night.
“Email us here!” I squeaked with cheer, 📬
A breadcrumb trail for friends to steer.
Ears up, paws down—support in sight! 🐇✨

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.


📜 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 db912fb and 522b3ae.

📒 Files selected for processing (1)
  • README.txt (1 hunks)
🔇 Additional comments (1)
README.txt (1)

41-41: LGTM — email contact added consistently.

Placement, formatting, and link scheme look correct and consistent with the surrounding bullets.

Pre-merge checks (3 passed)

✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The title "Add contact email" is a concise, single-sentence summary that directly reflects the main change—adding an email contact to the README. It is specific and relevant to the changeset described in the raw summary and avoids noisy or vague phrasing. A teammate scanning PR history will understand the primary intent from this title.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
✨ Finishing touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch add-contact-email

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

@xecdev xecdev requested a review from Klakurka September 12, 2025 17:45
@xecdev xecdev self-assigned this Sep 12, 2025
@xecdev xecdev added the documentation Improvements or additions to documentation label Sep 12, 2025
@xecdev xecdev merged commit abea10a into master Sep 13, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants